Documentation

nxos_bgp - Manages BGP configuration.

New in version 2.2.

Synopsis

  • Manages BGP configurations on NX-OS switches.

Parameters

Parameter Choices/Defaults Comments
asn
required
BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.
bestpath_always_compare_med
bool
    Choices:
  • no
  • yes
Enable/Disable MED comparison on paths from different autonomous systems.
bestpath_aspath_multipath_relax
bool
    Choices:
  • no
  • yes
Enable/Disable load sharing across the providers with different (but equal-length) AS paths.
bestpath_compare_neighborid
bool
    Choices:
  • no
  • yes
Enable/Disable neighborid. Use this when more paths available than max path config.
bestpath_compare_routerid
bool
    Choices:
  • no
  • yes
Enable/Disable comparison of router IDs for identical eBGP paths.
bestpath_cost_community_ignore
bool
    Choices:
  • no
  • yes
Enable/Disable Ignores the cost community for BGP best-path calculations.
bestpath_med_confed
bool
    Choices:
  • no
  • yes
Enable/Disable enforcement of bestpath to do a MED comparison only between paths originated within a confederation.
bestpath_med_missing_as_worst
bool
    Choices:
  • no
  • yes
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
bool
    Choices:
  • no
  • yes
Enable/Disable deterministic selection of the best MED pat from among the paths from the same autonomous system.
cluster_id
Route Reflector Cluster-ID.
confederation_id
Routing domain confederation AS.
confederation_peers
AS confederation parameters.
disable_policy_batching
bool
    Choices:
  • no
  • yes
Enable/Disable the batching evaluation of prefix advertisement to all peers.
disable_policy_batching_ipv4_prefix_list
Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.
disable_policy_batching_ipv6_prefix_list
Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.
enforce_first_as
bool
    Choices:
  • no
  • yes
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
    Choices:
  • size_small
  • size_medium
  • size_large
  • size_disable
  • default
Enable/Disable cli event history buffer.
event_history_detail
    Choices:
  • size_small
  • size_medium
  • size_large
  • size_disable
  • default
Enable/Disable detail event history buffer.
event_history_events
    Choices:
  • size_small
  • size_medium
  • size_large
  • size_disable
  • default
Enable/Disable event history buffer.
event_history_periodic
    Choices:
  • size_small
  • size_medium
  • size_large
  • size_disable
  • default
Enable/Disable periodic event history buffer.
fast_external_fallover
bool
    Choices:
  • no
  • yes
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
bool
    Choices:
  • no
  • yes
Enable/Disable flush routes in RIB upon controlled restart. On NX-OS, this property is only supported in the global BGP context.
graceful_restart
bool
    Choices:
  • no
  • yes
Enable/Disable graceful restart.
graceful_restart_helper
bool
    Choices:
  • no
  • yes
Enable/Disable graceful restart helper mode.
graceful_restart_timers_restart
Set maximum time for a restart sent to the BGP peer.
graceful_restart_timers_stalepath_time
Set maximum time that BGP keeps the stale routes from the restarting BGP peer.
isolate
bool
    Choices:
  • no
  • yes
Enable/Disable isolate this router from BGP perspective.
local_as
Local AS number to be used within a VRF instance.
log_neighbor_changes
bool
    Choices:
  • no
  • yes
Enable/Disable message logging for neighbor up/down event.
maxas_limit
Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values are between 1 and 512.
neighbor_down_fib_accelerate
bool
    Choices:
  • no
  • yes
Enable/Disable handle BGP neighbor down event, due to various reasons.
provider
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.
username
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.
authorize
bool

(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.
ssh_keyfile
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.
use_proxy
bool

(added in 2.5)
    Choices:
  • no
  • yes ←
If no, the environment variables http_proxy and https_proxy will be ignored.
auth_pass
(added in 2.5.3)
Default:
none
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.
host
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.
timeout
(added in 2.3)
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).
use_ssl
bool
    Choices:
  • no ←
  • yes
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
password
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.
validate_certs
bool
    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.
port 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).
transport
required
Default:
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.
reconnect_interval
The BGP reconnection interval for dropped sessions. Valid values are between 1 and 60.
router_id
Router Identifier (ID) of the BGP router VRF instance.
shutdown
bool
    Choices:
  • no
  • yes
Administratively shutdown the BGP protocol.
state
    Choices:
  • present ←
  • absent
Determines whether the config should be present or not on the device.
suppress_fib_pending
bool
    Choices:
  • no
  • yes
Enable/Disable advertise only routes programmed in hardware to peers.
timer_bestpath_limit
Specify timeout for the first best path after a restart, in seconds.
timer_bgp_hold
Set BGP hold timer.
timer_bgp_keepalive
Set BGP keepalive timer.
vrf
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 when vrf=default or the whole VRF instance within the BGP process when using a different VRF.
  • Default when supported restores params default value.
  • Configuring global parmas is only permitted if vrf=default.
  • 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 a simple ASN
  nxos_bgp:
      asn: 65535
      vrf: test
      router_id: 192.0.2.1
      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 test', 'router-id 192.0.2.1']


Status

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

Maintenance

This module is flagged as network which means that it is maintained by the Ansible Network Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Network Team, see here.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

Hint

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