dellemc.enterprise_sonic.sonic_bgp module – Manage global BGP and its parameters

Note

This module is part of the dellemc.enterprise_sonic collection (version 3.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.enterprise_sonic.

To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_bgp.

New in dellemc.enterprise_sonic 1.0.0

Synopsis

  • This module provides configuration management of global BGP parameters on devices running Enterprise SONiC Distribution by Dell Technologies.

Parameters

Parameter

Comments

config

list / elements=dictionary

Specifies the BGP-related configuration.

as_notation

string

Specify the AS number notation format

Option supported on Enterprise-Sonic releases 4.4.0 and higher.

Choices:

  • "asdot"

  • "asdot+"

bestpath

dictionary

Configures the BGP best-path.

as_path

dictionary

Configures the as-path values.

confed

boolean

Configures the confed values of as-path.

Choices:

  • false

  • true

ignore

boolean

Configures the ignore values of as-path.

Choices:

  • false

  • true

multipath_relax

boolean

Configures the multipath_relax values of as-path.

Choices:

  • false

  • true

multipath_relax_as_set

boolean

Configures the multipath_relax_as_set values of as-path.

Choices:

  • false

  • true

bandwidth

string

added in dellemc.enterprise_sonic 3.1.0

Link Bandwidth attribute for the bestpath selection process

Options are as follows

default_weight - Assign a low default weight (value 1) to paths not having link bandwidth

ignore_weight - Ignore link bandwidth (i.e., do regular ECMP, not weighted)

skip_missing - Ignore paths without link bandwidth for ECMP (if other paths have it)

Choices:

  • "default_weight"

  • "ignore_weight"

  • "skip_missing"

compare_routerid

boolean

Configures the compare_routerid.

Choices:

  • false

  • true

med

dictionary

Configures the med values.

always_compare_med

boolean

Allows comparing meds from different neighbors if set to true

Choices:

  • false

  • true

confed

boolean

Configures the confed values of med.

Choices:

  • false

  • true

missing_as_worst

boolean

Configures the missing_as_worst values of as-path.

Choices:

  • false

  • true

bgp_as

string / required

Specifies the BGP autonomous system (AS) number to configure on the device.

graceful_restart

dictionary

added in dellemc.enterprise_sonic 3.1.0

Configure graceful restart

enabled

boolean

Enable graceful restart

Choices:

  • false

  • true

preserve_fw_state

boolean

Configures preserve-fw-state

Choices:

  • false

  • true

restart_time

integer

Configures restart-time.

The range is from 1 to 3600.

stale_routes_time

integer

Configures stale-routes-time.

The range is from 1 to 3600.

log_neighbor_changes

boolean

Enables/disables logging neighbor up/down and reset reason.

Choices:

  • false

  • true

max_med

dictionary

Configure max med and its parameters

on_startup

dictionary

On startup time and max-med value

med_val

integer

on startup med value

timer

integer

Configures on startup time

router_id

string

Configures the BGP routing process router-id value.

rt_delay

integer

Time in seconds to wait before processing route-map changes.

Range is 0-600. 0 disables the timer and changes to route-map will not be updated.

timers

dictionary

Adjust routing timers

holdtime

integer

Configures hold-time

keepalive_interval

integer

Configures keepalive-interval

vrf_name

string

Specifies the VRF name.

Default: "default"

state

string

Specifies the operation to be performed on the BGP process that is configured on the device.

In case of merged, the input configuration is merged with the existing BGP configuration on the device.

In case of deleted, the existing BGP configuration is removed from the device.

In case of replaced, the existing configuration of the specified BGP AS will be replaced with provided configuration.

In case of overridden, the existing BGP configuration will be overridden with the provided configuration.

Choices:

  • "merged" ← (default)

  • "deleted"

  • "replaced"

  • "overridden"

Notes

Note

  • Tested against Enterprise SONiC Distribution by Dell Technologies.

  • Supports check_mode.

Examples

# Using "deleted" state
#
# Before state:
# -------------
#
# !
# router bgp 10 vrf VrfCheck1
#  router-id 10.2.2.32
#  route-map delay-timer 20
#  log-neighbor-changes
# !
# router bgp 11 vrf VrfCheck2
#  log-neighbor-changes
#  bestpath as-path ignore
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
# !
# router bgp 4
#  router-id 10.2.2.4
#  graceful-restart enable
#  graceful-restart restart-time 1
#  graceful-restart stalepath-time 500
#  route-map delay-timer 10
#  bestpath as-path ignore
#  bestpath as-path confed
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
#  bestpath bandwidth default-weight
# !
#
- name: Delete BGP Global attributes
  dellemc.enterprise_sonic.sonic_bgp:
    config:
      - bgp_as: 4
        router_id: 10.2.2.4
        rt_delay: 10
        log_neighbor_changes: false
        graceful_restart:
          stale_routes_time: 500
          restart_time: 1
        bestpath:
          as_path:
            confed: true
            ignore: true
            multipath_relax: false
            multipath_relax_as_set: true
          bandwidth: default_weight
          compare_routerid: true
          med:
            confed: true
            missing_as_worst: true
      - bgp_as: 10
        router_id: 10.2.2.32
        rt_delay: 20
        log_neighbor_changes: true
        vrf_name: 'VrfCheck1'
      - bgp_as: 11
        log_neighbor_changes: true
        vrf_name: 'VrfCheck2'
        bestpath:
          as_path:
            confed: false
            ignore: true
            multipath_relax_as_set: true
          compare_routerid: true
          med:
            confed: true
            missing_as_worst: true
    state: deleted


# After state:
# ------------
#
# !
# router bgp 10 vrf VrfCheck1
#  log-neighbor-changes
# !
# router bgp 11 vrf VrfCheck2
#  log-neighbor-changes
#  bestpath compare-routerid
# !
# router bgp 4
#  graceful-restart enable
#  log-neighbor-changes
#  bestpath compare-routerid
# !


# Using "deleted" state
#
# Before state:
# -------------
#
# !
# router bgp 10 vrf VrfCheck1
#  router-id 10.2.2.32
#  route-map delay-timer 20
#  log-neighbor-changes
# !
# router bgp 11 vrf VrfCheck2
#  graceful-restart enable
#  log-neighbor-changes
#  bestpath as-path ignore
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
#  bestpath bandwidth ignore-weight
# !
# router bgp 4
#  router-id 10.2.2.4
#  route-map delay-timer 10
#  bestpath as-path ignore
#  bestpath as-path confed
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
# !

- name: Deletes all the bgp global configurations
  dellemc.enterprise_sonic.sonic_bgp:
    config:
    state: deleted

# After state:
# ------------
#
# !
# !


# Using "merged" state
#
# Before state:
# -------------
#
# !
# router bgp 4
#  router-id 10.1.1.4
# !
#
- name: Merges provided configuration with device configuration
  dellemc.enterprise_sonic.sonic_bgp:
    config:
      - bgp_as: 4
        router_id: 10.2.2.4
        rt_delay: 10
        log_neighbor_changes: false
        graceful_restart:
          enabled: true
          preserve_fw_state: true
        timers:
          holdtime: 20
          keepalive_interval: 30
        bestpath:
          as_path:
            confed: true
            ignore: true
            multipath_relax: false
            multipath_relax_as_set: true
          bandwidth: ignore-weight
          compare_routerid: true
          med:
            confed: true
            missing_as_worst: true
            always_compare_med: true
        max_med:
          on_startup:
            timer: 667
            med_val: 7878
      - bgp_as: 10
        router_id: 10.2.2.32
        rt_delay: 20
        log_neighbor_changes: true
        vrf_name: 'VrfCheck1'
      - bgp_as: 11
        log_neighbor_changes: true
        vrf_name: 'VrfCheck2'
        bestpath:
          as_path:
            confed: false
            ignore: true
            multipath_relax_as_set: true
          compare_routerid: true
          med:
            confed: true
            missing_as_worst: true
    state: merged

#
# After state:
# ------------
#
# !
# router bgp 10 vrf VrfCheck1
#  router-id 10.2.2.32
#  route-map delay-timer 20
#  log-neighbor-changes
# !
# router bgp 11 vrf VrfCheck2
#  log-neighbor-changes
#  bestpath as-path ignore
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
# !
# router bgp 4
#  router-id 10.2.2.4
#  graceful-restart enable
#  graceful-restart preserve-fw-state
#  route-map delay-timer 10
#  bestpath as-path ignore
#  bestpath as-path confed
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
#  bestpath bandwidth ignore-weight
#  always-compare-med
#  max-med on-startup 667 7878
#  timers 20 30
#
# !


# Using "replaced" state
#
# Before state:
# -------------
#
# !
# router bgp 10 vrf VrfCheck1
#  router-id 10.2.2.32
#  log-neighbor-changes
#  timers 60 180
# !
# router bgp 4
#  router-id 10.2.2.4
#  max-med on-startup 667 7878
#  bestpath as-path ignore
#  bestpath as-path confed
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
#  bestpath bandwidth default-weight
#  timers 20 30
# !
#

- name: Replace device configuration of specified BGP AS with provided
  dellemc.enterprise_sonic.sonic_bgp:
    config:
      - bgp_as: 4
        router_id: 10.2.2.44
        log_neighbor_changes: true
        bestpath:
          as_path:
            confed: true
          bandwidth: skip_missing
          compare_routerid: true
      - bgp_as: 11
        vrf_name: 'VrfCheck2'
        router_id: 10.2.2.33
        log_neighbor_changes: true
        bestpath:
          as_path:
            confed: true
            ignore: true
          compare_routerid: true
          med:
            confed: true
            missing_as_worst: true
    state: replaced

#
# After state:
# ------------
#
# !
# router bgp 10 vrf VrfCheck1
#  router-id 10.2.2.32
#  log-neighbor-changes
#  timers 60 180
# !
# router bgp 11 vrf VrfCheck2
#  router-id 10.2.2.33
#  log-neighbor-changes
#  bestpath as-path ignore
#  bestpath as-path confed
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
#  timers 60 180
# !
# router bgp 4
#  router-id 10.2.2.44
#  log-neighbor-changes
#  bestpath as-path confed
#  bestpath compare-routerid
#  bestpath bandwidth skip_missing
#  timers 60 180
# !


# Using "overridden" state
#
# Before state:
# -------------
#
# !
# router bgp 10 vrf VrfCheck1
#  router-id 10.2.2.32
#  log-neighbor-changes
#  timers 60 180
# !
# router bgp 4
#  router-id 10.2.2.4
#  max-med on-startup 667 7878
#  bestpath as-path ignore
#  bestpath as-path confed
#  bestpath med missing-as-worst confed
#  bestpath compare-routerid
#  bestpath bandwidth default-weight
#  timers 20 30
# !
#

- name: Override device configuration of global BGP with provided configuration
  dellemc.enterprise_sonic.sonic_bgp:
    config:
      - bgp_as: 4
        router_id: 10.2.2.44
        log_neighbor_changes: true
        bestpath:
          as_path:
            confed: true
          compare_routerid: true
      - bgp_as: 11
        vrf_name: 'VrfCheck2'
        router_id: 10.2.2.33
        log_neighbor_changes: true
        bestpath:
          as_path:
            confed: true
            ignore: true
          compare_routerid: true
        timers:
          holdtime: 90
          keepalive_interval: 30
    state: overridden

#
# After state:
# ------------
#
# !
# router bgp 11 vrf VrfCheck2
#  router-id 10.2.2.33
#  log-neighbor-changes
#  bestpath as-path ignore
#  bestpath as-path confed
#  bestpath compare-routerid
#  timers 30 90
# !
# router bgp 4
#  router-id 10.2.2.44
#  log-neighbor-changes
#  bestpath as-path confed
#  bestpath compare-routerid
#  timers 60 180
# !

Return Values

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

Key

Description

after

list / elements=string

The resulting configuration module invocation.

Returned: when changed

Sample: ["The configuration returned is always in the same format as the parameters above.\n"]

before

list / elements=string

The configuration prior to the module invocation.

Returned: always

Sample: ["The configuration returned is always in the same format as the parameters above.\n"]

commands

list / elements=string

The set of commands pushed to the remote device.

Returned: always

Sample: ["command 1", "command 2", "command 3"]

Authors

  • Dhivya P (@dhivayp)