dellemc.enterprise_sonic.sonic_bfd module – Управление конфигурацией BFD на SONiC

Примечание

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

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

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

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

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

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

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

Этот модуль управляет конфигурацией BFD на устройствах под управлением SONiC

Параметры

Параметр	Комментарии
config dictionary	Задает конфигурацию BFD
multi_hops list / elements=dictionary	Список многоскачковых сеансов
detect_multiplier integer	Количество пропущенных пакетов, после которого сеанс BFD будет прерван По умолчанию: `3`
enabled boolean	Включает сеанс BFD, если установлено значение true Варианты: `false` `true` ← (по умолчанию)
local_address string / обязательный	Исходный IP-адрес для сеансов BFD через интерфейс
min_ttl integer	Минимальное ожидаемое значение TTL для полученных пакетов По умолчанию: `254`
passive_mode boolean	Если установлено значение true, узел BFD работает в пассивном режиме Варианты: `false` ← (по умолчанию) `true`
profile_name string	Имя профиля BFD
receive_interval integer	Задает интервал приема для соседнего узла По умолчанию: `300`
remote_address string / обязательный	IP-адрес, используемый удаленной системой для сеанса BFD
transmit_interval integer	Задает интервал передачи для соседнего узла По умолчанию: `300`
vrf string / обязательный	Имя настроенной на устройстве VRF
profiles list / elements=dictionary	Список профилей предварительной конфигурации
detect_multiplier integer	Количество пропущенных пакетов, после которого сеанс BFD будет прерван По умолчанию: `3`
echo_interval integer	Задает интервал эхо-пакетов По умолчанию: `300`
echo_mode boolean	Эхо-режим включен, если установлено значение true Варианты: `false` ← (по умолчанию) `true`
enabled boolean	Включает сеанс BFD, если установлено значение true Варианты: `false` `true` ← (по умолчанию)
min_ttl integer	Минимальное ожидаемое значение TTL для полученных пакетов По умолчанию: `254`
passive_mode boolean	Если установлено значение true, узел BFD работает в пассивном режиме Варианты: `false` ← (по умолчанию) `true`
profile_name string / обязательный	Имя профиля BFD
receive_interval integer	Задает интервал приема для соседнего узла По умолчанию: `300`
transmit_interval integer	Задает интервал передачи для соседнего узла По умолчанию: `300`
single_hops list / elements=dictionary	Список односкачковых сеансов
detect_multiplier integer	Количество пропущенных пакетов, после которого сеанс BFD будет прерван По умолчанию: `3`
echo_interval integer	Задает интервал эхо-пакетов По умолчанию: `300`
echo_mode boolean	Эхо-режим включен, если установлено значение true Варианты: `false` ← (по умолчанию) `true`
enabled boolean	Включает сеанс BFD, если установлено значение true Варианты: `false` `true` ← (по умолчанию)
interface string / обязательный	Интерфейс для связи с соседним узлом
local_address string / обязательный	Исходный IP-адрес для сеансов BFD через интерфейс
passive_mode boolean	Если установлено значение true, узел BFD работает в пассивном режиме Варианты: `false` ← (по умолчанию) `true`
profile_name string	Имя профиля BFD
receive_interval integer	Задает интервал приема для соседнего узла По умолчанию: `300`
remote_address string / обязательный	IP-адрес, используемый удаленной системой для сеанса BFD
transmit_interval integer	Задает интервал передачи для соседнего узла По умолчанию: `300`
vrf string / обязательный	Имя настроенной на устройстве VRF
state string	Состояние конфигурации после выполнения модуля. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

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

Примеры

# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show bfd profile
# (No "bfd profile" configuration present)
# sonic# show bfd peers
# (No "bfd peers" configuration present)

- name: Merge BFD configuration
  dellemc.enterprise_sonic.sonic_bfd:
  config:
    profiles:
      - profile_name: 'p1'
        enabled: true
        transmit_interval: 120
        receive_interval: 200
        detect_multiplier: 2
        passive_mode: true
        min_ttl: 140
        echo_interval: 150
        echo_mode: true
    single_hops:
      - remote_address: '196.88.6.1'
        vrf: 'default'
        interface: 'Ethernet20'
        local_address: '1.1.1.1'
        enabled: true
        transmit_interval: 50
        receive_interval: 80
        detect_multiplier: 4
        passive_mode: true
        echo_interval: 110
        echo_mode: true
        profile_name: 'p1'
    multi_hops:
      - remote_address: '192.40.1.3'
        vrf: 'default'
        local_address: '3.3.3.3'
        enabled: true
        transmit_interval: 75
        receive_interval: 100
        detect_multiplier: 3
        passive_mode: true
        min_ttl: 125
        profile_name: 'p1'
  state: merged

# After state:
# ------------
#
# sonic# show bfd profile
# BFD Profile:
#     Profile-name: p1
#         Enabled: True
#         Echo-mode: Enabled
#         Passive-mode: Enabled
#         Minimum-Ttl: 140
#         Detect-multiplier: 2
#         Receive interval: 200ms
#         Transmission interval: 120ms
#         Echo transmission interval: 150ms
# sonic# show bfd peers
# BFD Peers:
#
#     peer 192.40.1.3 multihop local-address 3.3.3.3 vrf default
#         ID: 989720421
#         Remote ID: 0
#         Passive mode: Enabled
#         Profile: p1
#         Minimum TTL: 125
#         Status: down
#         Downtime: 0 day(s), 0 hour(s), 1 min(s), 46 sec(s)
#         Diagnostics: ok
#         Remote diagnostics: ok
#         Peer Type: configured
#         Local timers:
#             Detect-multiplier: 2
#             Receive interval: 100ms
#             Transmission interval: 75ms
#             Echo transmission interval: ms
#         Remote timers:
#             Detect-multiplier: 3
#             Receive interval: 1000ms
#             Transmission interval: 1000ms
#             Echo transmission interval: 0ms
#
#     peer 196.88.6.1 local-address 1.1.1.1 vrf default interface Ethernet20
#         ID: 1134635660
#         Remote ID: 0
#         Passive mode: Enabled
#         Profile: p1
#         Status: down
#         Downtime: 0 day(s), 1 hour(s), 50 min(s), 48 sec(s)
#         Diagnostics: ok
#         Remote diagnostics: ok
#         Peer Type: configured
#         Local timers:
#             Detect-multiplier: 4
#             Receive interval: 80ms
#             Transmission interval: 50ms
#             Echo transmission interval: 110ms
#         Remote timers:
#             Detect-multiplier: 3
#             Receive interval: 1000ms
#             Transmission interval: 1000ms
#             Echo transmission interval: 0ms
#
#
# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show bfd profile
# BFD Profile:
#     Profile-name: p1
#         Enabled: True
#         Echo-mode: Enabled
#         Passive-mode: Enabled
#         Minimum-Ttl: 140
#         Detect-multiplier: 2
#         Receive interval: 200ms
#         Transmission interval: 120ms
#         Echo transmission interval: 150ms
#     Profile-name: p2
#         Enabled: True
#         Echo-mode: Disabled
#         Passive-mode: Disabled
#         Minimum-Ttl: 254
#         Detect-multiplier: 3
#         Receive interval: 300ms
#         Transmission interval: 300ms
#         Echo transmission interval: 300ms

- name: Replace BFD configuration
  dellemc.enterprise_sonic.sonic_bfd:
  config:
    profiles:
      - profile_name: 'p1'
        transmit_interval: 144
      - profile_name: 'p2'
        enabled: false
        transmit_interval: 110
        receive_interval: 235
        detect_multiplier: 5
        passive_mode: true
        min_ttl: 155
        echo_interval: 163
        echo_mode: true
  state: replaced

# After state:
# ------------
#
# sonic# show bfd profile
# BFD Profile:
#     Profile-name: p1
#         Enabled: True
#         Echo-mode: Enabled
#         Passive-mode: Enabled
#         Minimum-Ttl: 140
#         Detect-multiplier: 2
#         Receive interval: 200ms
#         Transmission interval: 144ms
#         Echo transmission interval: 150ms
#     Profile-name: p2
#         Enabled: False
#         Echo-mode: Enabled
#         Passive-mode: Enabled
#         Minimum-Ttl: 155
#         Detect-multiplier: 5
#         Receive interval: 235ms
#         Transmission interval: 110ms
#         Echo transmission interval: 163ms
#
#
# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show bfd peers
# BFD Peers:
#
#     peer 192.40.1.3 multihop local-address 3.3.3.3 vrf default
#         ID: 989720421
#         Remote ID: 0
#         Passive mode: Enabled
#         Profile: p1
#         Minimum TTL: 125
#         Status: down
#         Downtime: 0 day(s), 0 hour(s), 1 min(s), 46 sec(s)
#         Diagnostics: ok
#         Remote diagnostics: ok
#         Peer Type: configured
#         Local timers:
#             Detect-multiplier: 2
#             Receive interval: 100ms
#             Transmission interval: 75ms
#             Echo transmission interval: ms
#         Remote timers:
#             Detect-multiplier: 3
#             Receive interval: 1000ms
#             Transmission interval: 1000ms
#             Echo transmission interval: 0ms
#
#     peer 196.88.6.1 local-address 1.1.1.1 vrf default interface Ethernet20
#         ID: 1134635660
#         Remote ID: 0
#         Passive mode: Enabled
#         Profile: p1
#         Status: down
#         Downtime: 0 day(s), 1 hour(s), 50 min(s), 48 sec(s)
#         Diagnostics: ok
#         Remote diagnostics: ok
#         Peer Type: configured
#         Local timers:
#             Detect-multiplier: 4
#             Receive interval: 80ms
#             Transmission interval: 50ms
#             Echo transmission interval: 110ms
#         Remote timers:
#             Detect-multiplier: 3
#             Receive interval: 1000ms
#             Transmission interval: 1000ms
#             Echo transmission interval: 0ms

- name: Override BFD configuration
  dellemc.enterprise_sonic.sonic_bfd:
  config:
    single_hops:
      - remote_address: '172.68.2.1'
        vrf: 'default'
        interface: 'Ethernet16'
        local_address: '2.2.2.2'
        enabled: true
        transmit_interval: 60
        receive_interval: 88
        detect_multiplier: 6
        passive_mode: true
        echo_interval: 112
        echo_mode: true
        profile_name: 'p3'
    multi_hops:
      - remote_address: '186.42.1.2'
        vrf: 'default'
        local_address: '1.1.1.1'
        enabled: false
        transmit_interval: 85
        receive_interval: 122
        detect_multiplier: 4
        passive_mode: false
        min_ttl: 120
        profile_name: 'p3'
  state: overridden

# After state:
# ------------
#
# sonic# show bfd peers
# BFD Peers:
#
#     peer 186.42.1.2 multihop local-address 1.1.1.1 vrf default
#         ID: 989720421
#         Remote ID: 0
#         Passive mode: Disabled
#         Profile: p3
#         Minimum TTL: 120
#         Status: down
#         Downtime: 0 day(s), 0 hour(s), 1 min(s), 46 sec(s)
#         Diagnostics: ok
#         Remote diagnostics: ok
#         Peer Type: configured
#         Local timers:
#             Detect-multiplier: 4
#             Receive interval: 122ms
#             Transmission interval: 85ms
#             Echo transmission interval: ms
#         Remote timers:
#             Detect-multiplier: 3
#             Receive interval: 1000ms
#             Transmission interval: 1000ms
#             Echo transmission interval: 0ms
#
#     peer 172.68.2.1 local-address 2.2.2.2 vrf default interface Ethernet16
#         ID: 1134635660
#         Remote ID: 0
#         Passive mode: Enabled
#         Profile: p3
#         Status: down
#         Downtime: 0 day(s), 1 hour(s), 50 min(s), 48 sec(s)
#         Diagnostics: ok
#         Remote diagnostics: ok
#         Peer Type: configured
#         Local timers:
#             Detect-multiplier: 6
#             Receive interval: 88ms
#             Transmission interval: 60ms
#             Echo transmission interval: 112ms
#         Remote timers:
#             Detect-multiplier: 3
#             Receive interval: 1000ms
#             Transmission interval: 1000ms
#             Echo transmission interval: 0ms
#
#
# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show bfd profile
# BFD Profile:
#     Profile-name: p1
#         Enabled: True
#         Echo-mode: Enabled
#         Passive-mode: Enabled
#         Minimum-Ttl: 140
#         Detect-multiplier: 2
#         Receive interval: 200ms
#         Transmission interval: 120ms
#         Echo transmission interval: 150ms
# sonic# show bfd peers
# BFD Peers:
#
#     peer 192.40.1.3 multihop local-address 3.3.3.3 vrf default
#         ID: 989720421
#         Remote ID: 0
#         Passive mode: Enabled
#         Profile: p1
#         Minimum TTL: 125
#         Status: down
#         Downtime: 0 day(s), 0 hour(s), 1 min(s), 46 sec(s)
#         Diagnostics: ok
#         Remote diagnostics: ok
#         Peer Type: configured
#         Local timers:
#             Detect-multiplier: 2
#             Receive interval: 100ms
#             Transmission interval: 75ms
#             Echo transmission interval: ms
#         Remote timers:
#             Detect-multiplier: 3
#             Receive interval: 1000ms
#             Transmission interval: 1000ms
#             Echo transmission interval: 0ms
#
#     peer 196.88.6.1 local-address 1.1.1.1 vrf default interface Ethernet20
#         ID: 1134635660
#         Remote ID: 0
#         Passive mode: Enabled
#         Profile: p1
#         Status: down
#         Downtime: 0 day(s), 1 hour(s), 50 min(s), 48 sec(s)
#         Diagnostics: ok
#         Remote diagnostics: ok
#         Peer Type: configured
#         Local timers:
#             Detect-multiplier: 4
#             Receive interval: 80ms
#             Transmission interval: 50ms
#             Echo transmission interval: 110ms
#         Remote timers:
#             Detect-multiplier: 3
#             Receive interval: 1000ms
#             Transmission interval: 1000ms
#             Echo transmission interval: 0ms

- name: Delete BFD configuration
  dellemc.enterprise_sonic.sonic_bfd:
  config:
    profiles:
      - profile_name: 'p1'
        enabled: true
        transmit_interval: 120
        receive_interval: 200
        detect_multiplier: 2
        passive_mode: true
        min_ttl: 140
        echo_interval: 150
        echo_mode: true
    single_hops:
      - remote_address: '196.88.6.1'
        vrf: 'default'
        interface: 'Ethernet20'
        local_address: '1.1.1.1'
    multi_hops:
      - remote_address: '192.40.1.3'
        vrf: 'default'
        local_address: '3.3.3.3'
  state: deleted

# After state
# -----------
#
# sonic# show bfd profile
# BFD Profile:
#     Profile-name: p1
#         Enabled: True
#         Echo-mode: Disabled
#         Passive-mode: Disabled
#         Minimum-Ttl: 254
#         Detect-multiplier: 3
#         Receive interval: 300ms
#         Transmission interval: 300ms
#         Echo transmission interval: 300ms
# sonic# show bfd peers
# (No "bfd peers" configuration present)

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

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

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

Авторы

1. Talabi (@stalabi1)

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

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