dellemc / dellemc.enterprise_sonic / 2.4.0 / module / sonic_bgp Manage global BGP and its parameters | "added in version" 1.0.0 of dellemc.enterprise_sonic" Authors: Dhivya P (@dhivayp) This plugin has a corresponding action plugin.dellemc.enterprise_sonic.sonic_bgp (2.4.0) — module
Install with ansible-galaxy collection install dellemc.enterprise_sonic:==2.4.0
collections: - name: dellemc.enterprise_sonic version: 2.4.0
This module provides configuration management of global BGP parameters on devices running Enterprise SONiC Distribution by Dell Technologies.
# Using deleted # # 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 # route-map delay-timer 10 # bestpath as-path ignore # bestpath as-path confed # bestpath med missing-as-worst confed # bestpath compare-routerid # ! # - 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 bestpath: as_path: confed: True ignore: True multipath_relax: False multipath_relax_as_set: True 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 # log-neighbor-changes # bestpath compare-routerid # ! # Using deleted # # 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 # 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 # # 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 timers: holdtime: 20 keepalive_interval: 30 bestpath: as_path: confed: True ignore: True multipath_relax: False multipath_relax_as_set: True 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 # route-map delay-timer 10 # bestpath as-path ignore # bestpath as-path confed # bestpath med missing-as-worst confed # bestpath compare-routerid # always-compare-med # max-med on-startup 667 7878 # timers 20 30 # # ! # Using replaced # # 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 # 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 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 # timers 60 180 #! # Using overridden # # 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 # 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
state: choices: - merged - deleted - replaced - overridden default: merged description: - 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. type: str config: description: - Specifies the BGP-related configuration. elements: dict suboptions: bestpath: description: - Configures the BGP best-path. suboptions: as_path: description: - Configures the as-path values. suboptions: confed: description: - Configures the confed values of as-path. type: bool ignore: description: - Configures the ignore values of as-path. type: bool multipath_relax: description: - Configures the multipath_relax values of as-path. type: bool multipath_relax_as_set: description: - Configures the multipath_relax_as_set values of as-path. type: bool type: dict compare_routerid: description: - Configures the compare_routerid. type: bool med: description: - Configures the med values. suboptions: always_compare_med: description: - Allows comparing meds from different neighbors if set to true type: bool confed: description: - Configures the confed values of med. type: bool missing_as_worst: description: - Configures the missing_as_worst values of as-path. type: bool type: dict type: dict bgp_as: description: - Specifies the BGP autonomous system (AS) number to configure on the device. required: true type: str log_neighbor_changes: description: - Enables/disables logging neighbor up/down and reset reason. type: bool max_med: description: - Configure max med and its parameters suboptions: on_startup: description: - On startup time and max-med value suboptions: med_val: description: - on startup med value type: int timer: description: - Configures on startup time type: int type: dict type: dict router_id: description: - Configures the BGP routing process router-id value. type: str rt_delay: description: - 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. type: int timers: description: - Adjust routing timers suboptions: holdtime: description: - Configures hold-time type: int keepalive_interval: description: - Configures keepalive-interval type: int type: dict vrf_name: default: default description: - Specifies the VRF name. type: str type: list
after: description: The resulting configuration model invocation. returned: when changed sample: 'The configuration returned is always in the same format of the parameters above. ' type: list before: description: The configuration prior to the model invocation. returned: always sample: 'The configuration returned is always in the same format of the parameters above. ' type: list commands: description: The set of commands pushed to the remote device. returned: always sample: - command 1 - command 2 - command 3 type: list