Deprecated

Removed in None

i

Reason:Updated module released with more functionality. | Alternative:nxos_bgp_global

cisco.nxos.nxos_bgp (4.4.0) — module

(deprecated, removed after 2023-01-27) Manages BGP configuration.

| "added in version" 1.0.0 of cisco.nxos"

Authors: Jason Edelman (@jedelman8), Gabriele Gerbino (@GGabriele)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.nxos:==4.4.0


Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 4.4.0

Description

Manages BGP configurations on NX-OS switches.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure a simple ASN
  cisco.nxos.nxos_bgp:
    asn: 65535
    vrf: test
    router_id: 192.0.2.1
    state: present

Inputs

    
asn:
    description:
    - BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT
      notation.
    required: true
    type: str

vrf:
    default: default
    description:
    - Name of the VRF. The name 'default' is a valid VRF representing the global BGP.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines whether the config should be present or not on the device.
    type: str

isolate:
    description:
    - Enable/Disable isolate this router from BGP perspective.
    type: bool

local_as:
    description:
    - Local AS number to be used within a VRF instance.
    type: str

shutdown:
    description:
    - Administratively shutdown the BGP protocol.
    type: bool

router_id:
    description:
    - Router Identifier (ID) of the BGP router VRF instance.
    type: str

cluster_id:
    description:
    - Route Reflector Cluster-ID.
    type: str

maxas_limit:
    description:
    - Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values
      are between 1 and 512.
    type: str

flush_routes:
    description:
    - Enable/Disable flush routes in RIB upon controlled restart. On NX-OS, this property
      is only supported in the global BGP context.
    type: bool

timer_bgp_hold:
    description:
    - Set BGP hold timer.
    type: str

confederation_id:
    description:
    - Routing domain confederation AS.
    type: str

enforce_first_as:
    description:
    - 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.
    type: bool

graceful_restart:
    description:
    - Enable/Disable graceful restart.
    type: bool

event_history_cli:
    choices:
    - size_small
    - size_medium
    - size_large
    - size_disable
    - default
    - 'true'
    - 'false'
    description:
    - Enable/Disable cli event history buffer.
    type: str

reconnect_interval:
    description:
    - The BGP reconnection interval for dropped sessions. Valid values are between 1 and
      60.
    type: str

bestpath_med_confed:
    description:
    - Enable/Disable enforcement of bestpath to do a MED comparison only between paths
      originated within a confederation.
    type: bool

confederation_peers:
    description:
    - AS confederation parameters.
    elements: str
    type: list

timer_bgp_keepalive:
    description:
    - Set BGP keepalive timer.
    type: str

event_history_detail:
    choices:
    - size_small
    - size_medium
    - size_large
    - size_disable
    - default
    - 'true'
    - 'false'
    description:
    - Enable/Disable detail event history buffer.
    type: str

event_history_events:
    choices:
    - size_small
    - size_medium
    - size_large
    - size_disable
    - default
    - 'true'
    - 'false'
    description:
    - Enable/Disable event history buffer.
    type: str

log_neighbor_changes:
    description:
    - Enable/Disable message logging for neighbor up/down event.
    type: bool

suppress_fib_pending:
    description:
    - Enable/Disable advertise only routes programmed in hardware to peers.
    type: bool

timer_bestpath_limit:
    description:
    - Specify timeout for the first best path after a restart, in seconds.
    type: str

event_history_periodic:
    choices:
    - size_small
    - size_medium
    - size_large
    - size_disable
    - default
    - 'true'
    - 'false'
    description:
    - Enable/Disable periodic event history buffer.
    type: str

fast_external_fallover:
    description:
    - Enable/Disable immediately reset the session if the link to a directly connected
      BGP peer goes down.  Only supported in the global BGP context.
    type: bool

disable_policy_batching:
    description:
    - Enable/Disable the batching evaluation of prefix advertisement to all peers.
    type: bool

graceful_restart_helper:
    description:
    - Enable/Disable graceful restart helper mode.
    type: bool

bestpath_compare_routerid:
    description:
    - Enable/Disable comparison of router IDs for identical eBGP paths.
    type: bool

bestpath_always_compare_med:
    description:
    - Enable/Disable MED comparison on paths from different autonomous systems.
    type: bool

bestpath_compare_neighborid:
    description:
    - Enable/Disable neighborid. Use this when more paths available than max path config.
    type: bool

neighbor_down_fib_accelerate:
    description:
    - Enable/Disable handle BGP neighbor down event, due to various reasons.
    type: bool

bestpath_med_missing_as_worst:
    description:
    - Enable/Disable assigns the value of infinity to received routes that do not carry
      the MED attribute, making these routes the least desirable.
    type: bool

bestpath_cost_community_ignore:
    description:
    - Enable/Disable Ignores the cost community for BGP best-path calculations.
    type: bool

bestpath_med_non_deterministic:
    description:
    - Enable/Disable deterministic selection of the best MED pat from among the paths
      from the same autonomous system.
    type: bool

bestpath_aspath_multipath_relax:
    description:
    - Enable/Disable load sharing across the providers with different (but equal-length)
      AS paths.
    type: bool

graceful_restart_timers_restart:
    description:
    - Set maximum time for a restart sent to the BGP peer.
    type: str

graceful_restart_timers_stalepath_time:
    description:
    - Set maximum time that BGP keeps the stale routes from the restarting BGP peer.
    type: str

disable_policy_batching_ipv4_prefix_list:
    description:
    - Enable/Disable the batching evaluation of prefix advertisements to all peers with
      prefix list.
    type: str

disable_policy_batching_ipv6_prefix_list:
    description:
    - Enable/Disable the batching evaluation of prefix advertisements to all peers with
      prefix list.
    type: str

Outputs

commands:
  description: commands sent to the device
  returned: always
  sample:
  - router bgp 65535
  - vrf test
  - router-id 192.0.2.1
  type: list