Модуль dellemc.enterprise_sonic.sonic_bgp_af — управление глобальным семейством адресов BGP и его параметрами

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install dellemc.enterprise_sonic.

Чтобы использовать её в плейбуке, укажите: dellemc.enterprise_sonic.sonic_bgp_af.

Новое в dellemc.enterprise_sonic 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль предназначен для управления конфигурацией глобальных параметров BGP_AF на устройствах под управлением Enterprise SONiC.
Перед использованием на устройстве необходимо создать bgp_as и vrf_name.

Параметры

Параметр	Комментарии
config list / elements=dictionary	Задаёт конфигурацию, связанную с BGP_AF.
address_family dictionary	Задаёт конфигурацию, связанную с семейством адресов BGP.
afis list / elements=dictionary	Список семейств адресов, таких как ipv4, ipv6 и l2vpn. Параметры afi и safi необходимо указывать вместе.
advertise_all_vni boolean	Задаёт флаг анонсирования всех VNI. Варианты: `false` `true`
advertise_default_gw boolean	Задаёт флаг анонсирования шлюза по умолчанию. Варианты: `false` `true`
advertise_pip boolean	Включает анонсирование PIP. Варианты: `false` `true`
advertise_pip_ip string	IPv4-адрес PIP
advertise_pip_peer_ip string	IPv4-адрес узла PIP
advertise_svi_ip boolean	Включает анонсирование маршрутов MACIP для SVI. Варианты: `false` `true`
afi string / обязательный	Тип настраиваемого семейства адресов. Варианты: `"ipv4"` `"ipv6"` `"l2vpn"`
aggregate_address_config list / elements=dictionary добавлено в dellemc.enterprise_sonic 2.5.0	Конфигурация агрегированного адреса
as_set boolean	Включает или отключает формирование информации о пути AS set. Варианты: `false` `true`
policy_name string	Предварительно настроенная политика маршрутизации (имя route map), применяемая к агрегированной сети
prefix string / обязательный	Префикс агрегированного адреса
summary_only boolean	Включает или отключает ограничение сведений о маршрутах, включаемых в обновления. Варианты: `false` `true`
dampening boolean	Если значение равно true, включается подавление флаппинга маршрутов. Варианты: `false` `true`
dup_addr_detection dictionary добавлено в dellemc.enterprise_sonic 3.1.0	Конфигурация обнаружения дублирующихся адресов. Параметры max_moves и time необходимо указывать вместе.
enabled boolean	Включает обнаружение дублирующихся адресов. Варианты: `false` `true`
freeze string	Задаёт заморозку обнаружения дублирующихся адресов. Значением может быть `permanent` или время в диапазоне от 30 до 3600. `permanent` — включить постоянную заморозку.
max_moves integer	Задаёт максимальное допустимое число перемещений до обнаружения дублирующегося адреса. Диапазон значений: от 2 до 1000.
time integer	Задаёт время обнаружения дублирующегося адреса. Диапазон значений: от 2 до 1800.
import dictionary добавлено в dellemc.enterprise_sonic 2.5.0	Задаёт маршруты для импорта в это семейство адресов.
vrf dictionary	Импортирует маршруты из других VRF.
route_map string	Задаёт route map.
vrf_list list / elements=string	Задаёт VRF, из которых следует импортировать маршруты.
max_path dictionary	Задаёт максимальное количество путей для ibgp и ebgp.
ebgp integer	Задаёт количество многопутевых маршрутов ebgp.
ibgp integer	Задаёт количество многопутевых маршрутов ibgp.
network list / elements=string	Включает маршрутизацию в IP-сети для каждого указанного префикса сети.
rd string	Задаёт различитель маршрутов, используемый экземпляром VRF.
redistribute list / elements=dictionary	Задаёт сведения о маршрутах, перераспределяемых из другого протокола маршрутизации.
metric string	Задаёт метрику для перераспределяемых маршрутов.
protocol string / обязательный	Задаёт протокол для настройки перераспределения маршрутов. Варианты: `"ospf"` `"static"` `"connected"`
route_map string	Задаёт ссылку на route map.
route_advertise_list list / elements=dictionary	Список анонсируемых маршрутов
advertise_afi string / обязательный	Задаёт семейство адресов Варианты: `"ipv4"` `"ipv6"`
route_map string	Задаёт ссылку на route map
rt_in list / elements=string	Целевые маршруты для импорта.
rt_out list / elements=string	Целевые маршруты для экспорта.
safi string	Задаёт тип передачи данных для семейства адресов. Варианты: `"unicast"` ← (по умолчанию) `"evpn"`
vnis list / elements=dictionary	Конфигурация VNI для EVPN.
advertise_default_gw boolean	Задаёт флаг анонсирования шлюза по умолчанию. Варианты: `false` `true`
advertise_svi_ip boolean	Включает анонсирование маршрутов MACIP для SVI. Варианты: `false` `true`
rd string	Задаёт различитель маршрутов, используемый экземпляром VRF.
rt_in list / elements=string	Целевые маршруты для импорта.
rt_out list / elements=string	Целевые маршруты для экспорта.
vni_number integer / обязательный	Задаёт номер VNI.
bgp_as string / обязательный	Задаёт номер автономной системы BGP (AS), уже настроенный на устройстве.
vrf_name string	Задаёт имя VRF, уже настроенное на устройстве. По умолчанию: `"default"`
state string	Задаёт операцию, выполняемую над процессом BGP_AF, настроенным на устройстве. При значении merged входная конфигурация объединяется с существующей конфигурацией BGP_AF на устройстве. При значении deleted существующая конфигурация BGP_AF удаляется с устройства. При значении replaced существующая конфигурация BGP_AF для указанной BGP AS заменяется предоставленной конфигурацией. При значении overridden существующая конфигурация BGP_AF перезаписывается предоставленной конфигурацией. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"overridden"` `"replaced"`

Примечания

Примечание

Тестирование выполнено на Enterprise SONiC Distribution от Dell Technologies.
Поддерживает check_mode.

Примеры

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 3.3.3.3/16
#   aggregate-address 1.1.1.1/1
#   aggregate-address 5.5.5.5/5 as-set summary-only route-map rmap-1
#   dampening
#   import vrf route-map rmap-1
#   import vrf default
# !
# router bgp 51
#  router-id 111.2.2.41
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   dampening
#  !
#  address-family ipv6 unicast
#   redistribute connected route-map bb metric 21
#   redistribute ospf route-map aa metric 27
#   redistribute static route-map bb metric 26
#   maximum-paths 4
#   maximum-paths ibgp 5
#  !
#  address-family l2vpn evpn
#   advertise-svi-ip
#   advertise ipv6 unicast route-map aa
#   rd 3.3.3.3:33
#   route-target import 22:22
#   route-target export 33:33
#   dup-addr-detection
#   advertise-pip ip 1.1.1.1 peer-ip 2.2.2.2
#   !
#   vni 1
#    advertise-default-gw
#    advertise-svi-ip
#    rd 5.5.5.5:55
#    route-target import 88:88
#    route-target export 77:77
#

- name: Delete BGP Address family configuration from the device
  dellemc.enterprise_sonic.sonic_bgp_af:
    config:
      - bgp_as: 51
        address_family:
          afis:
            - afi: l2vpn
              safi: evpn
              advertise_pip: true
              advertise_pip_ip: "1.1.1.1"
              advertise_pip_peer_ip: "2.2.2.2"
              advertise_svi_ip: true
              advertise_all_vni: false
              advertise_default_gw: false
              route_advertise_list:
                - advertise_afi: ipv6
                  route_map: aa
              rd: "3.3.3.3:33"
              rt_in:
                - "22:22"
              rt_out:
                - "33:33"
              vnis:
                - vni_number: 1
            - afi: ipv4
              safi: unicast
            - afi: ipv6
              safi: unicast
              max_path:
                ebgp: 2
                ibgp: 5
              redistribute:
                - metric: "21"
                  protocol: connected
                  route_map: bb
                - metric: "27"
                  protocol: ospf
                  route_map: aa
                - metric: "26"
                  protocol: static
                  route_map: bb
      - bgp_as: 51
        vrf_name: VrfReg1
        address_family:
          afis:
            - afi: ipv4
              safi: unicast
              import:
                vrf:
                  vrf_list:
                    - default
                  route_map: rmap-1
              aggregate_address_config:
                - prefix: "1.1.1.1/1"
                - prefix: "5.5.5.5/5"
                  as_set: true
                  policy_name: rmap-1
                  summary_only: true
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 3.3.3.3/16
#   aggregate-address 5.5.5.5/5
#   dampening
# !
# router bgp 51
#  router-id 111.2.2.41
#  timers 60 180
#  !
#  address-family ipv6 unicast
#  !
#  address-family l2vpn evpn
#   dup-addr-detection
#

#  Using "deleted" state
#
#  Before state:
#  -------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 3.3.3.3/16
#   aggregate-address 5.5.5.5/5 as-set summary-only route-map rmap-1
#   dampening
#   import vrf route-map rmap-1
#   import vrf default
# !
# router bgp 51
#  router-id 111.2.2.41
#  timers 60 180
#  !
#  address-family ipv6 unicast
#  !
#  address-family l2vpn evpn
#

- name: Delete All BGP address family configurations
  dellemc.enterprise_sonic.sonic_bgp_af:
    config:
    state: deleted


# After state:
# ------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
# !
# router bgp 51
#  router-id 111.2.2.41
#  timers 60 180
#

#  Using "merged" state
#
#  Before state:
#  -------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
# !
# router bgp 51
#  router-id 111.2.2.41
#  timers 60 180
#  !
#  address-family l2vpn evpn
#   dup-addr-detection
#

- name: Merge provided BGP address family configuration on the device.
  dellemc.enterprise_sonic.sonic_bgp_af:
    config:
      - bgp_as: 51
        address_family:
          afis:
            - afi: l2vpn
              safi: evpn
              advertise_pip: true
              advertise_pip_ip: "3.3.3.3"
              advertise_pip_peer_ip: "4.4.4.4"
              advertise_svi_ip: true
              advertise_all_vni: false
              advertise_default_gw: false
              dup_addr_detection:
                freeze: permanent
                max_moves: 10
                time: 600
              route_advertise_list:
                - advertise_afi: ipv4
                  route_map: bb
              rd: "1.1.1.1:11"
              rt_in:
                - "12:12"
              rt_out:
                - "13:13"
              vnis:
                - vni_number: 1
                  advertise_default_gw: true
                  advertise_svi_ip: true
                  rd: "5.5.5.5:55"
                  rt_in:
                    - "88:88"
                  rt_out:
                    - "77:77"
            - afi: ipv4
              safi: unicast
              network:
                - 2.2.2.2/16
                - 192.168.10.1/32
              dampening: true
              aggregate_address_config:
                - prefix: 1.1.1.1/1
                  as_set: true
                  policy_name: bb
                  summary_only: true
            - afi: ipv6
              safi: unicast
              max_path:
                ebgp: 4
                ibgp: 5
              redistribute:
                - metric: "21"
                  protocol: connected
                  route_map: bb
                - metric: "27"
                  protocol: ospf
                  route_map: aa
                - metric: "26"
                  protocol: static
                  route_map: bb
      - bgp_as: 51
        vrf_name: VrfReg1
        address_family:
          afis:
            - afi: ipv4
              safi: unicast
              import:
                vrf:
                  vrf_list:
                    - default
                  route_map: rmap-1
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   import vrf route-map rmap-1
#   import vrf default
# !
# router bgp 51
#  router-id 111.2.2.41
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   network 2.2.2.2/16
#   network 192.168.10.1/32
#   aggregate-address 1.1.1.1/1 as-set summary-only route-map bb
#   dampening
#  !
#  address-family ipv6 unicast
#   redistribute connected route-map bb metric 21
#   redistribute ospf route-map aa metric 27
#   redistribute static route-map bb metric 26
#   maximum-paths 4
#   maximum-paths ibgp 5
#  !
#  address-family l2vpn evpn
#   advertise-svi-ip
#   advertise ipv4 unicast route-map bb
#   rd 1.1.1.1:11
#   route-target import 12:12
#   route-target import 13:13
#   dup-addr-detection max-moves 10 time 600
#   dup-addr-detection freeze permanent
#   advertise-pip ip 3.3.3.3 peer-ip 4.4.4.4
#   !
#   vni 1
#    advertise-default-gw
#    advertise-svi-ip
#    rd 5.5.5.5:55
#    route-target import 88:88
#    route-target export 77:77
#

# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 3.3.3.3/16
#   dampening
# !
# router bgp 51 vrf VrfReg2
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   import vrf route-map rmap-1
#   import vrf default
# !
# router bgp 51
#  router-id 111.2.2.41
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   redistribute connected route-map bb metric 21
#   redistribute ospf route-map bb metric 27
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 2.2.2.2/16
#   network 192.168.10.1/32
#   aggregate-address 5.5.5.5/5 as-set summary-only route-map bb
#   dampening
#  !
#  address-family ipv6 unicast
#   redistribute static route-map aa metric 26
#   maximum-paths 4
#   maximum-paths ibgp 5
#  !
#  address-family l2vpn evpn
#   advertise-all-vni
#   advertise-svi-ip
#   advertise ipv4 unicast route-map bb
#   rd 1.1.1.1:11
#   route-target import 12:12
#   route-target export 13:13
#   advertise-pip ip 3.3.3.3 peer-ip 4.4.4.4
#   no dup-addr-detection
#   !
#   vni 1
#    advertise-default-gw
#    advertise-svi-ip
#    rd 5.5.5.5:55
#    route-target import 88:88
#    route-target export 77:77
#

- name: Replace device configuration of address families of specified BGP AS with provided configuration.
  dellemc.enterprise_sonic.sonic_bgp_af:
    config:
      - bgp_as: 51
        address_family:
          afis:
            - afi: l2vpn
              safi: evpn
              advertise_pip: true
              advertise_pip_ip: "3.3.3.3"
              advertise_pip_peer_ip: "4.4.4.4"
              advertise_svi_ip: true
              advertise_all_vni: true
              advertise_default_gw: false
              route_advertise_list:
                - advertise_afi: ipv4
                  route_map: bb
              rd: "1.1.1.1:11"
              rt_in:
                - "22:22"
              rt_out:
                - "13:13"
              vnis:
                - vni_number: 5
                  advertise_default_gw: true
                  advertise_svi_ip: true
                  rd: "10.10.10.10:55"
                  rt_in:
                    - "88:88"
                  rt_out:
                    - "77:77"
            - afi: ipv4
              safi: unicast
              network:
                - 2.2.2.2/16
                - 192.168.10.1/32
              dampening: true
              redistribute:
                - protocol: connected
                - protocol: ospf
                  metric: 30
              aggregate-address-config:
                - prefix: '5.5.5.5/5'
                  as_set: true
      - bgp_as: 51
        vrf_name: VrfReg2
        address_family:
          afis:
            - afi: ipv4
              safi: unicast
              import:
                vrf:
                  vrf_list:
                    - VrfReg1
                  route_map: rmap-reg1
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 3.3.3.3/16
#   dampening
# !
# router bgp 51 vrf VrfReg2
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   import vrf route-map rmap-reg1
#   import vrf VrfReg1
# !
# router bgp 51
#  router-id 111.2.2.41
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   redistribute connected
#   redistribute ospf metric 30
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 2.2.2.2/16
#   network 192.168.10.1/32
#   aggregate-address 5.5.5.5/5 as-set
#   dampening
#  !
#  address-family ipv6 unicast
#   redistribute static route-map aa metric 26
#   maximum-paths 4
#   maximum-paths ibgp 5
#  !
#  address-family l2vpn evpn
#   advertise-all-vni
#   advertise-svi-ip
#   advertise ipv4 unicast route-map bb
#   rd 1.1.1.1:11
#   route-target import 22:22
#   route-target export 13:13
#   dup-addr-detection
#   advertise-pip ip 3.3.3.3 peer-ip 4.4.4.4
#   !
#   vni 5
#    advertise-default-gw
#    advertise-svi-ip
#    rd 10.10.10.10:55
#    route-target import 88:88
#    route-target export 77:77
#

# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 3.3.3.3/16
#   dampening
#   import vrf route-map rmap-1
#   import vrf default
# !
# router bgp 51
#  router-id 111.2.2.41
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   redistribute connected route-map bb metric 21
#   redistribute ospf route-map bb metric 27
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 2.2.2.2/16
#   network 192.168.10.1/32
#   dampening
#  !
#  address-family ipv6 unicast
#   redistribute static route-map aa metric 26
#   maximum-paths 4
#   maximum-paths ibgp 5
#  !
#  address-family l2vpn evpn
#   advertise-all-vni
#   advertise-svi-ip
#   advertise ipv4 unicast route-map bb
#   rd 1.1.1.1:11
#   route-target import 12:12
#   route-target export 13:13
#   dup-addr-detection max-moves 10 time 600
#   dup-addr-detection freeze permanent
#   advertise-pip ip 3.3.3.3 peer-ip 4.4.4.4
#   !
#   vni 1
#    advertise-default-gw
#    advertise-svi-ip
#    rd 5.5.5.5:55
#    route-target import 88:88
#    route-target export 77:77
#

- name: Override device configuration of BGP address families with provided configuration.
  dellemc.enterprise_sonic.sonic_bgp_af:
    config:
      - bgp_as: 51
        address_family:
          afis:
            - afi: l2vpn
              safi: evpn
              advertise_pip: true
              advertise_pip_ip: "3.3.3.3"
              advertise_pip_peer_ip: "4.4.4.4"
              advertise_svi_ip: true
              advertise_all_vni: true
              advertise_default_gw: false
              dup_addr_detection:
                freeze: '600'
              route_advertise_list:
                - advertise_afi: ipv4
                  route_map: bb
              rd: "1.1.1.1:11"
              rt_in:
                - "22:22"
              rt_out:
                - "13:13"
              vnis:
                - vni_number: 5
                  advertise_default_gw: true
                  advertise_svi_ip: true
                  rd: "10.10.10.10:55"
                  rt_in:
                    - "88:88"
                  rt_out:
                    - "77:77"
            - afi: ipv4
              safi: unicast
              network:
                - 2.2.2.2/16
                - 192.168.10.1/32
              dampening: true
              redistribute:
                - protocol: connected
                - protocol: ospf
                  metric: 30
              aggregate_address_config:
                - prefix: 4.4.4.4/4
                  as_set: true
                  policy_name: bb
                  summary_only: true
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration bgp
# !
# router bgp 51 vrf VrfReg1
#  log-neighbor-changes
#  timers 60 180
# !
# router bgp 51
#  router-id 111.2.2.41
#  log-neighbor-changes
#  timers 60 180
#  !
#  address-family ipv4 unicast
#   redistribute connected
#   redistribute ospf metric 30
#   maximum-paths 1
#   maximum-paths ibgp 1
#   network 2.2.2.2/16
#   network 192.168.10.1/32
#   aggregate-address 4.4.4.4/4 as-set summary-only route-map bb
#   dampening
#  !
#  address-family l2vpn evpn
#   advertise-all-vni
#   advertise-svi-ip
#   advertise ipv4 unicast route-map bb
#   rd 1.1.1.1:11
#   route-target import 22:22
#   route-target export 13:13
#   dup-addr-detection
#   dup-addr-detection freeze 600
#   advertise-pip ip 3.3.3.3 peer-ip 4.4.4.4
#   !
#   vni 5
#    advertise-default-gw
#    advertise-svi-ip
#    rd 10.10.10.10:55
#    route-target import 88:88
#    route-target export 77:77
#

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
after список / элементы=строки	Конфигурация, полученная в результате вызова модуля. Возвращается: при изменении Пример: `["The configuration returned always in the same format as the parameters above.\n"]`
before список / элементы=строки	Конфигурация до вызова модуля. Возвращается: всегда Пример: `["The configuration returned is always in the same format as the parameters above.\n"]`
commands список / элементы=строки	Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

Niraimadaiselvam M (@niraimadaiselvamm)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_bgp_af_module.html