W3cubDocs

/Ansible

nxos_bgp - Manages BGP configuration.

New in version 2.2.

Synopsis

Manages BGP configurations on NX-OS switches.

Options

parameter required default choices comments
asn
 yes
BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.
bestpath_always_compare_med
 no
  • true
  • false
Enable/Disable MED comparison on paths from different autonomous systems.
bestpath_aspath_multipath_relax
 no
  • true
  • false
Enable/Disable load sharing across the providers with different (but equal-length) AS paths.
bestpath_compare_routerid
 no
  • true
  • false
Enable/Disable comparison of router IDs for identical eBGP paths.
bestpath_cost_community_ignore
 no
  • true
  • false
Enable/Disable Ignores the cost community for BGP best-path calculations.
bestpath_med_confed
 no
  • true
  • false
Enable/Disable enforcement of bestpath to do a MED comparison only between paths originated within a confederation.
bestpath_med_missing_as_worst
 no
  • true
  • false
Enable/Disable assigns the value of infinity to received routes that do not carry the MED attribute, making these routes the least desirable.
bestpath_med_non_deterministic
 no
  • true
  • false
Enable/Disable deterministic selection of the best MED pat from among the paths from the same autonomous system.
cluster_id
 no
Route Reflector Cluster-ID.
confederation_id
 no
Routing domain confederation AS.
confederation_peers
 no
AS confederation parameters.
disable_policy_batching
 no
  • true
  • false
Enable/Disable the batching evaluation of prefix advertisement to all peers.
disable_policy_batching_ipv4_prefix_list
 no
Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.
disable_policy_batching_ipv6_prefix_list
 no
Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.
enforce_first_as
 no
  • true
  • false
Enable/Disable enforces the neighbor autonomous system to be the first AS number listed in the AS path attribute for eBGP. On NX-OS, this property is only supported in the global BGP context.
event_history_cli
 no
  • size_small
  • size_medium
  • size_large
  • size_disable
  • default
Enable/Disable cli event history buffer.
event_history_detail
 no
  • size_small
  • size_medium
  • size_large
  • size_disable
  • default
Enable/Disable detail event history buffer.
event_history_events
 no
  • size_small
  • size_medium
  • size_large
  • size_disable
  • default
Enable/Disable event history buffer.
event_history_periodic
 no
  • size_small
  • size_medium
  • size_large
  • size_disable
  • default
Enable/Disable periodic event history buffer.
fast_external_fallover
 no
  • true
  • false
Enable/Disable immediately reset the session if the link to a directly connected BGP peer goes down. Only supported in the global BGP context.
flush_routes
 no
  • true
  • false
Enable/Disable flush routes in RIB upon controlled restart. On NX-OS, this property is only supported in the global BGP context.
graceful_restart
 no
  • true
  • false
Enable/Disable graceful restart.
graceful_restart_helper
 no
  • true
  • false
Enable/Disable graceful restart helper mode.
graceful_restart_timers_restart
 no
  • true
  • false
Set maximum time for a restart sent to the BGP peer.
graceful_restart_timers_stalepath_time
 no
  • true
  • false
Set maximum time that BGP keeps the stale routes from the restarting BGP peer.
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.
isolate
 no
  • true
  • false
Enable/Disable isolate this router from BGP perspective.
local_as
 no
Local AS number to be used within a VRF instance.
log_neighbor_changes
 no
  • true
  • false
Enable/Disable message logging for neighbor up/down event.
maxas_limit
 no
Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values are between 1 and 512.
neighbor_down_fib_accelerate
 no
  • true
  • false
Enable/Disable handle BGP neighbor down event, due to various reasons.
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.
reconnect_interval
 no
The BGP reconnection interval for dropped sessions. Valid values are between 1 and 60.
router_id
 no
Router Identifier (ID) of the BGP router VRF instance.
shutdown
 no
  • true
  • false
Administratively shutdown the BGP protocol.
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_fib_pending
 no
  • true
  • false
Enable/Disable advertise only routes programmed in hardware to peers.
timer_bestpath_limit
 no
Specify timeout for the first best path after a restart, in seconds.
timer_bestpath_limit_always
 no
  • true
  • false
Enable/Disable update-delay-always option.
timer_bgp_hold
 no
Set BGP hold timer.
timer_bgp_keepalive
 no
Set BGP keepalive timer.
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. 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
Name of the VRF. The name 'default' is a valid VRF representing the global BGP.

Examples

# configure a simple asn
- nxos_bgp:
      asn: 65535
      vrf: test
      router_id: 1.1.1.1
      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 BGP configuration after module execution verbose mode dict {'router_id': '1.1.1.1', 'neighbor_down_fib_accelerate': False, 'confederation_peers': '', 'confederation_id': '', 'bestpath_compare_neighborid': False, 'local_as': '', 'bestpath_always_compare_med': False, 'bestpath_med_non_deterministic': False, 'cluster_id': '', 'vrf': 'test', 'graceful_restart_helper': False, 'timer_bgp_hold': '180', 'bestpath_aspath_multipath_relax': False, 'asn': '65535', 'timer_bestpath_limit': '', 'graceful_restart_timers_stalepath_time': '300', 'graceful_restart_timers_restart': '120', 'maxas_limit': '', 'bestpath_med_confed': False, 'log_neighbor_changes': False, 'timer_bgp_keepalive': '60', 'bestpath_cost_community_ignore': False, 'reconnect_interval': '60', 'suppress_fib_pending': False, 'bestpath_med_missing_as_worst': False, 'bestpath_compare_routerid': False, 'graceful_restart': True}
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 test', 'router-id 1.1.1.1']
proposed k/v pairs of parameters passed into module verbose mode dict {'router_id': '1.1.1.1', 'asn': '65535', 'vrf': 'test'}
existing k/v pairs of existing BGP configuration verbose mode dict {'router_id': '11.11.11.11', 'neighbor_down_fib_accelerate': False, 'confederation_peers': '', 'confederation_id': '', 'bestpath_compare_neighborid': False, 'local_as': '', 'bestpath_always_compare_med': False, 'bestpath_med_non_deterministic': False, 'cluster_id': '', 'vrf': 'test', 'graceful_restart_helper': False, 'timer_bgp_hold': '180', 'bestpath_aspath_multipath_relax': False, 'asn': '65535', 'timer_bestpath_limit': '', 'graceful_restart_timers_stalepath_time': '300', 'graceful_restart_timers_restart': '120', 'maxas_limit': '', 'bestpath_med_confed': False, 'log_neighbor_changes': False, 'timer_bgp_keepalive': '60', 'bestpath_cost_community_ignore': False, 'reconnect_interval': '60', 'suppress_fib_pending': False, 'bestpath_med_missing_as_worst': False, 'bestpath_compare_routerid': False, 'graceful_restart': True}

Notes

Note

state=absent removes the whole BGP ASN configuration when vrf=default or the whole VRF instance within the BGP process when using a different VRF.

Note

Default when supported restores params default value.

Note

Configuring global parmas is only permitted if vrf=default.

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_module.html