Модуль dellemc.enterprise_sonic.sonic_bgp_neighbors_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_neighbors_af.

Добавлено в dellemc.enterprise_sonic 1.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
config list / elements=dictionary	Задаёт конфигурацию, связанную с семейством адресов соседей BGP.
bgp_as string / required	Задаёт номер автономной системы BGP (AS), уже настроенный на устройстве.
neighbors list / elements=dictionary	Задаёт конфигурацию соседей BGP в режиме настройки семейства адресов.
address_family list / elements=dictionary	Задаёт конфигурацию, связанную с семейством адресов BGP. Параметры afi и safi необходимо указывать вместе.
activate boolean	Включает семейство адресов для этого соседа. Варианты: `false` `true`
afi string / required	Тип настраиваемого семейства адресов. Варианты: `"ipv4"` `"ipv6"` `"l2vpn"`
allowas_in dictionary	Критерий принятия полученных объявлений, содержащих номер AS этого маршрутизатора BGP в AS_PATH полученных объявлений. Параметру «origin» нельзя присвоить значение true, если задан параметр «value».
origin boolean	Принимать заданную AS этого экземпляра маршрутизатора BGP как исходную. Варианты: `false` `true`
value integer	Принимать объявления, в которых заданная AS этого маршрутизатора BGP встречается в AS-PATH не более указанного числа раз. (Укажите число в диапазоне 1–10.)
fabric_external boolean	Настраивает соседа как внешнего для фабрики. Внешние соседи фабрики поддерживаются только для семейства адресов l2vpn. Варианты: `false` `true`
ip_afi dictionary	Общие атрибуты конфигурации для семейств адресов одноадресной рассылки IPv4 и IPv6.
default_policy_name string	Задаёт определение политики маршрутизации.
send_default_route boolean	Включает или отключает отправку маршрута по умолчанию соседу. Варианты: `false` ← (по умолчанию) `true`
prefix_limit dictionary	Задаёт атрибуты ограничения количества префиксов для ipv4-unicast и ipv6-unicast.
discard_extra boolean	Включает или отключает отбрасывание лишних префиксов в сеансе BGP при превышении максимального предела префиксов. Варианты: `false` ← (по умолчанию) `true`
max_prefixes integer	Максимальное количество префиксов, принимаемых от соседа.
prevent_teardown boolean	Включает или отключает разрыв сеанса BGP при превышении максимального предела префиксов. Варианты: `false` ← (по умолчанию) `true`
restart_timer integer	Интервал времени в секундах, по истечении которого после разрыва устанавливается сеанс BGP.
warning_threshold integer	Пороговое количество префиксов, полученных от соседа, при достижении которого генерируются предупреждения. Задаётся в процентах от значения max-prefixes.
prefix_list_in string	Политика входной фильтрации маршрутов для соседа.
prefix_list_out string	Политика выходной фильтрации маршрутов для соседа.
route_map list / elements=dictionary	Задаёт карту маршрутизации.
direction string	Задаёт направление действия карты маршрутизации.
name string	Задаёт имя карты маршрутизации.
route_reflector_client boolean	Указывает, что сосед является клиентом отражателя маршрутов. Варианты: `false` `true`
route_server_client boolean	Указывает, что сосед является клиентом сервера маршрутизации. Варианты: `false` `true`
safi string	Задаёт тип рассылки для семейства адресов. Варианты: `"unicast"` ← (по умолчанию) `"evpn"`
neighbor string / required	Адрес маршрутизатора-соседа, уже настроенный на устройстве.
vrf_name string	Задаёт имя VRF, уже настроенное на устройстве. По умолчанию: `"default"`
state string	Задаёт операцию, выполняемую над процессом BGP, настроенным на устройстве. При значении merged входная конфигурация объединяется с существующей конфигурацией BGP на устройстве. При значении deleted существующая конфигурация BGP удаляется с устройства. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

Проверено на дистрибутиве Enterprise SONiC от Dell Technologies.
Поддерживает check_mode.

Примеры

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor interface Eth1/3
#  !
#  address-family ipv4 unicast
#   activate
#   allowas-in 4
#   route-map aa in
#   route-map aa out
#   route-reflector-client
#   route-server-client
#   send-community both
# !

- name: Delete specific BGP neighbors AF attributes
  dellemc.enterprise_sonic.sonic_bgp_neighbors_af:
     config:
        - bgp_as: 4
          neighbors:
             - neighbor: Eth1/3
               address_family:
                  - afi: ipv4
                    safi: unicast
                    allowas_in:
                       value: 4
                    route_map:
                       - name: aa
                         direction: in
                       - name: aa
                         direction: out
                    route_reflector_client: true
                    route_server_client: true
     state: deleted

# After state:
# ------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor interface Eth1/3
#  !
#  address-family ipv4 unicast
#   send-community both
# !


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp neighbor vrf default 1.1.1.1
# (No bgp neighbor configuration present)
- name: "Configure BGP neighbor prefix-list attributes"
  dellemc.enterprise_sonic.sonic_bgp_neighbors_af:
     config:
        - bgp_as: 51
          neighbors:
             - neighbor: 1.1.1.1
               address_family:
                  - afi: ipv4
                    safi: unicast
                    ip_afi:
                       default_policy_name: rmap_reg1
                       send_default_route: true
                    prefix_limit:
                       max_prefixes: 2
                       discard_extra: true
                       warning_threshold: 60
                    prefix_list_in: p1
                    prefix_list_out: p2
     state: merged
# After state:
# ------------
#
# sonic# show running-configuration bgp neighbor vrf default 1.1.1.1
# !
# neighbor 1.1.1.1
#  !
#  address-family ipv4 unicast
#   default-originate route-map rmap_reg1
#   prefix-list p1 in
#   prefix-list p2 out
#   send-community both
#   maximum-prefix 2 60 discard-extra


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor 1.1.1.1
#  !
#  address-family ipv6 unicast
#   default-originate route-map rmap_reg2
#   prefix-list p1 in
#   prefix-list p2 out
#   send-community both
#   maximum-prefix 5 90 restart 2

- name: Delete BGP neighbors AF prefix-list attributes
  dellemc.enterprise_sonic.sonic_bgp_neighbors_af:
     config:
        - bgp_as: 51
          neighbors:
             - neighbor: 1.1.1.1
               address_family:
                  - afi: ipv6
                    safi: unicast
                    ip_afi:
                       default_policy_name: rmap_reg2
                       send_default_route: true
                    prefix_limit:
                       max_prefixes: 5
                       warning_threshold: 90
                       restart-timer: 2
                    prefix_list_in: p1
                    prefix_list_out: p2
     state: deleted

# After state:
# ------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor 1.1.1.1
# !


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor interface Eth1/3
#  !
#  address-family ipv4 unicast
#   activate
#   allowas-in 4
#   route-map aa in
#   route-map aa out
#   route-reflector-client
#   route-server-client
#   send-community both
# !
# neighbor interface Eth1/5
#  !
#  address-family ipv4 unicast
#   activate
#   allowas-in origin
#   send-community both
# !

- name: Delete all BGP neighbors AF configuration
  dellemc.enterprise_sonic.sonic_bgp_neighbors_af:
     config:
     state: deleted

# After state:
# ------------
#
# sonic# show running-configuration bgp neighbor vrf default
# (No bgp neighbor configuration present)


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor interface Eth1/3
# !

- name: Merge BGP neighbors AF configuration
  dellemc.enterprise_sonic.sonic_bgp_neighbors_af:
     config:
        - bgp_as: 4
          neighbors:
             - neighbor: Eth1/3
               address_family:
                  - afi: ipv4
                    safi: unicast
                    allowas_in:
                       value: 4
                    route_map:
                       - name: aa
                         direction: in
                       - name: aa
                         direction: out
                    route_reflector_client: true
                    route_server_client: true
     state: merged

# After state:
# ------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor interface Eth1/3
#  !
#  address-family ipv4 unicast
#   activate
#   allowas-in 4
#   route-map aa in
#   route-map aa out
#   route-reflector-client
#   route-server-client
#   send-community both
# !


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp neighbor vrf default
# (No bgp neighbor configuration present)

- name: Configure BGP neighbors AF prefix-list attributes
  dellemc.enterprise_sonic.sonic_bgp_neighbors_af:
     config:
        - bgp_as: 51
          neighbors:
             - neighbor: 1.1.1.1
               address_family:
                  - afi: ipv4
                    safi: unicast
                    ip_afi:
                       default_policy_name: rmap_reg1
                       send_default_route: true
                    prefix_limit:
                       max_prefixes: 1
                       prevent_teardown: true
                       warning_threshold: 80
                    prefix_list_in: p1
                    prefix_list_out: p2
     state: merged

# After state:
# ------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor 1.1.1.1
#  !
#  address-family ipv4 unicast
#   default-originate route-map rmap_reg1
#   prefix-list p1 in
#   prefix-list p2 out
#   send-community both
#   maximum-prefix 1 80 warning-only
# !


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor 1.1.1.1
#  !
#  address-family ipv6 unicast
#   default-originate route-map rmap_reg2
#   prefix-list p1 in
#   prefix-list p2 out
#   send-community both
#   maximum-prefix 5 90 restart 2
# !

- name: Replace BGP neighbors AF attributes
  dellemc.enterprise_sonic.sonic_bgp_neighbors_af:
     config:
        - bgp_as: 51
          neighbors:
             - neighbor: 1.1.1.1
               address_family:
                  - afi: ipv4
                    safi: unicast
                    ip_afi:
                       default_policy_name: rmap_reg1
                       send_default_route: true
                    prefix_limit:
                       max_prefixes: 1
                       prevent_teardown: true
                       warning_threshold: 80
                    prefix_list_in: p1
                    prefix_list_out: p2
     state: replaced

# After state:
# ------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor 1.1.1.1
#  !
#  address-family ipv4 unicast
#   default-originate route-map rmap_reg1
#   prefix-list p1 in
#   prefix-list p2 out
#   send-community both
#   maximum-prefix 1 80 warning-only
# !


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor 1.1.1.1
#  !
#  address-family ipv6 unicast
#   default-originate route-map rmap_reg2
#   prefix-list p1 in
#   prefix-list p2 out
#   send-community both
#   maximum-prefix 5 90 restart 2
# !

- name: Override BGP neighbors AF configuration
  dellemc.enterprise_sonic.sonic_bgp_neighbors_af:
     config:
        - bgp_as: 51
          neighbors:
             - neighbor: 2.2.2.2
               address_family:
                  - afi: ipv4
                    safi: unicast
                    ip_afi:
                       default_policy_name: rmap_reg1
                       send_default_route: true
                    prefix_limit:
                       max_prefixes: 1
                       prevent_teardown: true
                       warning_threshold: 80
                    prefix_list_in: p1
                    prefix_list_out: p2
     state: overridden

# After state:
# ------------
#
# sonic# show running-configuration bgp neighbor vrf default
# !
# neighbor 2.2.2.2
#  !
#  address-family ipv4 unicast
#   default-originate route-map rmap_reg1
#   prefix-list p1 in
#   prefix-list p2 out
#   send-community both
#   maximum-prefix 1 80 warning-only
# !

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

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

Ключ	Описание
after list / elements=string	Итоговая конфигурация после вызова модуля. Возвращается: при изменении Пример: `["The configuration returned is always in the same format as the parameters above.\n"]`
after(generated) list / elements=string	Сгенерированная конфигурация после вызова модуля. Возвращается: когда `check_mode` Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
before list / elements=string	Конфигурация до вызова модуля. Возвращается: всегда Пример: `["The configuration returned is always in the same format as the parameters above.\n"]`
commands list / elements=string	Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: `["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_neighbors_af_module.html