W3cubDocs

/Ansible

nxos_bgp_neighbor_af - Manages BGP address-family’s neighbors configuration.

New in version 2.2.

Synopsis

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

Options

parameter required default choices comments
additional_paths_receive
 no
  • 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
 no
  • 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
 no
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
 no
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
 yes
  • ipv4
  • ipv6
  • vpnv4
  • vpnv6
  • l2vpn
Address Family Identifier.
allowas_in
 no
Activate allowas-in property
allowas_in_max
 no
Optional max-occurrences value for allowas_in. Valid values are an integer value or 'default'. Can be used independently or in conjunction with allowas_in.
as_override
 no
  • true
  • false
Activate the as-override feature.
asn
 yes
BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.
default_originate
 no
  • true
  • false
Activate the default-originate feature.
default_originate_route_map
 no
Optional route-map for the default_originate property. Can be used independently or in conjunction with default_originate. Valid values are a string defining a route-map name, or 'default'.
filter_list_in
 no
Valid values are a string defining a filter-list name, or 'default'.
filter_list_out
 no
Valid values are a string defining a filter-list name, or '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.
max_prefix_interval
 no
Optional restart interval. Valid values are an integer. Requires max_prefix_limit.
max_prefix_limit
 no
maximum-prefix limit value. Valid values are an integer value or 'default'.
max_prefix_threshold
 no
Optional threshold percentage at which to generate a warning. Valid values are an integer value. Requires max_prefix_limit.
max_prefix_warning
 no
  • true
  • false
Optional warning-only keyword. Requires max_prefix_limit.
neighbor
 yes
Neighbor Identifier. Valid values are string. Neighbors may use IPv4 or IPv6 notation, with or without prefix length.
next_hop_self
 no
  • true
  • false
Activate the next-hop-self feature.
next_hop_third_party
 no
  • true
  • false
Activate the next-hop-third-party feature.
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).
prefix_list_in
 no
Valid values are a string defining a prefix-list name, or 'default'.
prefix_list_out
 no
Valid values are a string defining a prefix-list name, or 'default'.
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.
route_map_in
 no
Valid values are a string defining a route-map name, or 'default'.
route_map_out
 no
Valid values are a string defining a route-map name, or 'default'.
route_reflector_client
 no
  • true
  • false
Router reflector client.
safi
 yes
  • unicast
  • multicast
  • evpn
Sub Address Family Identifier.
send_community
 no
  • none
  • both
  • extended
  • standard
  • default
send-community attribute.
soft_reconfiguration_in
 no
  • 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
 no
Site-of-origin. Valid values are a string defining a VPN extcommunity or 'default'.
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
  • default
suppress-inactive feature.
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.
unsuppress_map
 no
unsuppress-map. Valid values are a string defining a route-map name or 'default'.
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. The value of username 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.
vrf
 no default
Name of the VRF. The name 'default' is a valid VRF representing the global bgp.
weight
 no
Weight value. Valid values are an integer value or 'default'.

Examples

configure RR client
- nxos_bgp_neighbor_af:
    asn: 65535
    neighbor: '3.3.3.3'
    afi: ipv4
    safi: unicast
    route_reflector_client: true
    state: present
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state k/v pairs of configuration after module execution verbose mode dict {'default_originate': False, 'route_reflector_client': True, 'additional_paths_send': 'inherit', 'soo': '', 'additional_paths_receive': 'inherit', 'suppress_inactive': False, 'unsuppress_map': '', 'prefix_list_out': '', 'as_override': False, 'filter_list_out': '', 'afi': 'ipv4', 'allowas_in': False, 'max_prefix_warning': '', 'max_prefix_threshold': '', 'advertise_map_non_exist': [], 'default_originate_route_map': '', 'send_community': '', 'safi': 'unicast', 'filter_list_in': '', 'weight': '', 'vrf': 'default', 'max_prefix_limit': '', 'asn': '65535', 'route_map_in': '', 'soft_reconfiguration_in': 'inherit', 'max_prefix_interval': '', 'route_map_out': '', 'next_hop_self': False, 'prefix_list_in': '', 'neighbor': '3.3.3.3', 'next_hop_third_party': True, 'advertise_map_exist': [], 'allowas_in_max': ''}
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', 'neighbor 3.3.3.3', 'address-family ipv4 unicast', 'route-reflector-client']
proposed k/v pairs of parameters passed into module verbose mode dict {'route_reflector_client': True, 'afi': 'ipv4', 'neighbor': '3.3.3.3', 'safi': 'unicast', 'asn': '65535', 'vrf': 'default'}
existing k/v pairs of existing configuration verbose mode dict {}

Notes

Note

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

Note

Default, when supported, removes properties

Note

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

This is a Core Module

For more information on what this means please read Core Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_bgp_neighbor_af_module.html