модуль dellemc.enterprise_sonic.sonic_bgp – Управление глобальным 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.

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

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

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

Этот модуль обеспечивает управление конфигурацией глобальных параметров BGP на устройствах под управлением Enterprise SONiC Distribution by Dell Technologies.

Параметры

Параметр	Комментарии
config list / elements=dictionary	Задаёт конфигурацию, связанную с BGP.
as_notation string	Задаёт формат представления номера AS. Параметр поддерживается в Enterprise-Sonic версии 4.4.0 и выше. Варианты: `"asdot"` `"asdot+"`
bestpath dictionary	Настраивает выбор наилучшего пути BGP.
as_path dictionary	Настраивает значения AS-пути.
confed boolean	Настраивает значения confed для AS-пути. Варианты: `false` `true`
ignore boolean	Настраивает значения ignore для AS-пути. Варианты: `false` `true`
multipath_relax boolean	Настраивает значения multipath_relax для AS-пути. Варианты: `false` `true`
multipath_relax_as_set boolean	Настраивает значения multipath_relax_as_set для AS-пути. Варианты: `false` `true`
bandwidth string добавлено в dellemc.enterprise_sonic 3.1.0	Атрибут пропускной способности канала для процесса выбора наилучшего пути Доступны следующие варианты default_weight — назначить низкий вес по умолчанию (значение 1) путям без атрибута пропускной способности канала ignore_weight — игнорировать пропускную способность канала (то есть использовать обычный ECMP, а не взвешенный) skip_missing — исключать из ECMP пути без атрибута пропускной способности канала (если он есть у других путей) Варианты: `"default_weight"` `"ignore_weight"` `"skip_missing"`
compare_routerid boolean	Настраивает compare_routerid. Варианты: `false` `true`
med dictionary	Настраивает значения MED.
always_compare_med boolean	Если задано значение true, разрешает сравнивать MED от разных соседей. Варианты: `false` `true`
confed boolean	Настраивает значения confed для MED. Варианты: `false` `true`
missing_as_worst boolean	Настраивает значение missing_as_worst для AS-пути. Варианты: `false` `true`
bgp_as string / обязательный	Задаёт номер автономной системы (AS) BGP для настройки на устройстве.
graceful_restart dictionary добавлено в dellemc.enterprise_sonic 3.1.0	Настраивает плавный перезапуск
enabled boolean	Включает плавный перезапуск Варианты: `false` `true`
preserve_fw_state boolean	Настраивает preserve-fw-state Варианты: `false` `true`
restart_time integer	Настраивает время перезапуска. Диапазон: от 1 до 3600.
stale_routes_time integer	Настраивает время хранения устаревших маршрутов. Диапазон: от 1 до 3600.
log_neighbor_changes boolean	Включает или отключает ведение журнала событий подключения и отключения соседей, а также причин сброса. Варианты: `false` `true`
max_med dictionary	Настраивает max med и его параметры
on_startup dictionary	Время запуска и значение max-med
med_val integer	Значение MED при запуске
timer integer	Настраивает время запуска
router_id string	Настраивает значение router-id процесса маршрутизации BGP.
rt_delay integer	Время в секундах ожидания перед обработкой изменений route-map. Диапазон: 0–600. Значение 0 отключает таймер, и изменения route-map не будут обновляться.
timers dictionary	Настраивает таймеры маршрутизации
holdtime integer	Настраивает время удержания
keepalive_interval integer	Настраивает интервал keepalive
vrf_name string	Задаёт имя VRF. По умолчанию: `"default"`
state string	Задаёт операцию, выполняемую над настроенным на устройстве процессом BGP. При значении merged входная конфигурация объединяется с существующей конфигурацией BGP на устройстве. При значении deleted существующая конфигурация BGP удаляется с устройства. При значении replaced существующая конфигурация указанной AS BGP заменяется предоставленной конфигурацией. При значении overridden существующая конфигурация BGP перезаписывается предоставленной конфигурацией. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

Проверено на Enterprise SONiC Distribution by Dell Technologies.
Поддерживает check_mode.

Примеры

# 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
# !

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

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

Ключ	Описание
after list / elements=string	Конфигурация после вызова модуля. Возвращается: при наличии изменений Пример: `["The configuration returned is always 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"]`

Авторы

Dhivya P (@dhivayp)

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

© 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_module.html