модуль dellemc.enterprise_sonic.sonic_stp — управление конфигурацией STP на 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_stp.

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

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

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

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

Параметры

Параметр	Описание
config dictionary	Задает конфигурацию STP mstp, pvst и rapid_pvst являются взаимоисключающими.
global dictionary	Глобальная конфигурация STP
bpdu_filter boolean	Включает фильтр BPDU для граничного порта Варианты: `false` `true`
bridge_priority integer	Настраиваемая составляющая идентификатора моста Значение должно быть кратно 4096 и находиться в диапазоне 0–61440
disabled_vlans list / elements=string	Список VLAN, для которых STP отключен. Значением элемента списка может быть один идентификатор VLAN или диапазон идентификаторов VLAN с разделителем «-» или «..», например 70-100 или 70..100.
enabled_protocol string	Задает тип STP, включенный на устройстве Варианты: `"mst"` `"pvst"` `"rapid_pvst"`
fwd_delay integer	Задержка в секундах, используемая мостами STP для перевода корневых и назначенных портов в состояние пересылки Диапазон 4–30
hello_time integer	Интервал в секундах между периодическими передачами сообщений конфигурации назначенными портами Диапазон 1–10
loop_guard boolean	Настройка защиты от петель по умолчанию для моста Варианты: `false` `true`
max_age integer	Максимальный срок актуальности информации в секундах, передаваемой мостом, когда он является корневым мостом Диапазон 6–40
portfast boolean	Глобально включает PortFast на всех портах доступа Настраивается для протокола pvst Варианты: `false` `true`
root_guard_timeout integer	Задает тайм-аут восстановления root guard в секундах, по истечении которого порт возвращается в состояние пересылки Диапазон 5–600
interfaces list / elements=dictionary	Конфигурация STP для интерфейсов
bpdu_filter boolean	Включает фильтр BPDU для граничного порта Варианты: `false` `true`
bpdu_guard boolean	Включает BPDU guard для граничного порта Варианты: `false` `true`
cost integer	Вклад порта в стоимость корневого пути для моста, когда этот порт является корневым Диапазон 1–200000000
edge_port boolean	Настраивает интерфейс как граничный порт STP Варианты: `false` `true`
guard string	Включает root guard или защиту от петель Варианты: `"loop"` `"root"` `"none"`
intf_name string / обязательный	Имя интерфейса
link_type string	Задает тип канала интерфейса Варианты: `"point-to-point"` `"shared"`
port_priority integer	Настраиваемая составляющая идентификатора порта Диапазон 0–240
portfast boolean	Включает или отключает PortFast на указанном интерфейсе Настраивается для протокола pvst Варианты: `false` `true`
shutdown boolean	Отключает порт при получении BPDU Варианты: `false` `true`
stp_enable boolean	Включает STP на интерфейсе Варианты: `false` `true`
uplink_fast boolean	Включает UplinkFast Варианты: `false` `true`
mstp dictionary	Конфигурация множественного STP
fwd_delay integer	Задержка в секундах, используемая мостами STP для перевода корневых и назначенных портов в состояние пересылки Диапазон 4–30
hello_time integer	Интервал в секундах между периодическими передачами сообщений конфигурации назначенными портами Диапазон 1–10
max_age integer	Максимальный срок актуальности информации в секундах, передаваемой мостом, когда он является корневым мостом Диапазон 6–40
max_hop integer	Количество мостов в регионе MST, через которые может пройти BPDU до отбрасывания Диапазон 1–40
mst_instances list / elements=dictionary	Конфигурация экземпляров MST
bridge_priority integer	Настраиваемая составляющая идентификатора моста Значение должно быть кратно 4096 и находиться в диапазоне 0–61440
interfaces list / elements=dictionary	Список интерфейсов с включенным STP
cost integer	Вклад порта в стоимость корневого пути для моста, когда этот порт является корневым Диапазон 1–200000000
intf_name string / обязательный	Ссылка на интерфейс STP
port_priority integer	Настраиваемая составляющая идентификатора порта, диапазон 0–240
mst_id integer / обязательный	Значение, используемое для идентификации экземпляра MST, диапазон 0–4094
vlans list / elements=string	Список VLAN, сопоставленных с экземпляром MST. Значением элемента списка может быть один идентификатор VLAN или диапазон идентификаторов VLAN с разделителем «-» или «..», например 70-100 или 70..100.
mst_name string	Имя идентификатора конфигурации MST
revision integer	Уровень ревизии идентификатора конфигурации MST, диапазон 0–65535
pvst list / elements=dictionary	Конфигурация STP для каждой VLAN
bridge_priority integer	Настраиваемая составляющая идентификатора моста Значение должно быть кратно 4096 и находиться в диапазоне 0–61440
fwd_delay integer	Задержка в секундах, используемая мостами STP для перевода корневых и назначенных портов в состояние пересылки Диапазон 4–30
hello_time integer	Интервал в секундах между периодическими передачами сообщений конфигурации назначенными портами Диапазон 1–10
interfaces list / elements=dictionary	Список интерфейсов с включенным STP
cost integer	Вклад порта в стоимость корневого пути для моста, когда этот порт является корневым Диапазон 1–200000000
intf_name string / обязательный	Ссылка на интерфейс STP
port_priority integer	Настраиваемая составляющая идентификатора порта, диапазон 0–240
max_age integer	Максимальный срок актуальности информации в секундах, передаваемой мостом, когда он является корневым мостом Диапазон 6–40
vlan_id integer / обязательный	Идентификатор VLAN, диапазон 1–4094
rapid_pvst list / elements=dictionary	Конфигурация быстрого STP для каждой VLAN
bridge_priority integer	Настраиваемая составляющая идентификатора моста Значение должно быть кратно 4096 и находиться в диапазоне 0–61440
fwd_delay integer	Задержка в секундах, используемая мостами STP для перевода корневых и назначенных портов в состояние пересылки Диапазон 4–30
hello_time integer	Интервал в секундах между периодическими передачами сообщений конфигурации назначенными портами Диапазон 1–10
interfaces list / elements=dictionary	Список интерфейсов с включенным STP
cost integer	Вклад порта в стоимость корневого пути для моста, когда этот порт является корневым Диапазон 1–200000000
intf_name string / обязательный	Ссылка на интерфейс STP
port_priority integer	Настраиваемая составляющая идентификатора порта, диапазон 0–240
max_age integer	Максимальный срок актуальности информации в секундах, передаваемой мостом, когда он является корневым мостом Диапазон 6–40
vlan_id integer / обязательный	Идентификатор VLAN, диапазон 1–4094
state string	Состояние конфигурации после выполнения модуля Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

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

Примеры

# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration spanning-tree
# (No spanning-tree configuration present)

- name: Merge STP configurations
  dellemc.enterprise_sonic.sonic_stp:
    config:
      global:
        enabled_protocol: mst
        loop_guard: true
        bpdu_filter: true
        disabled_vlans:
          - 4-6
        hello_time: 5
        max_age: 10
        fwd_delay: 20
        bridge_priority: 4096
      interfaces:
        - intf_name: Ethernet20
          edge_port: true
          link_type: shared
          guard: loop
          bpdu_guard: true
          bpdu_filter: true
          uplink_fast: true
          shutdown: true
          cost: 20
          port_priority: 30
          stp_enable: true
      mstp:
        mst_name: mst1
        revision: 1
        max_hop: 3
        hello_time: 6
        max_age: 9
        fwd_delay: 12
        mst_instances:
          - mst_id: 1
            bridge_priority: 2048
            vlans:
              - 1
            interfaces:
              - intf_name: Ethernet20
                cost: 60
                port_priority: 65
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration spanning-tree
#  no spanning-tree vlan 4-6
#  spanning-tree mode mst
#  spanning-tree edge-port bpdufilter default
#  spanning-tree forward-time 20
#  spanning-tree hello-time 5
#  spanning-tree max-age 10
#  spanning-tree loopguard default
#  spanning-tree mst hello-time 6
#  spanning-tree mst forward-time 12
#  spanning-tree mst max-age 9
#  spanning-tree mst max-hops 3
#  spanning-tree mst 1 priority 2048
#  !
#  spanning-tree mst configuration
#   name mst1
#   revision 1
#   instance 1 vlan 1
#   activate
#  !
#  interface Ethernet20
#   spanning-tree bpdufilter enable
#   spanning-tree guard loop
#   spanning-tree bpduguard port-shutdown
#   spanning-tree cost 20
#   spanning-tree link-type shared
#   spanning-tree port-priority 30
#   spanning-tree port type edge
#   spanning-tree uplinkfast
#   spanning-tree mst 1 cost 60
#   spanning-tree mst 1 port-priority 65


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration spanning-tree
#  no spanning-tree vlan 4-6
#  spanning-tree mode mst
#  spanning-tree edge-port bpdufilter default
#  spanning-tree loopguard default
#  spanning-tree mst hello-time 6
#  spanning-tree mst forward-time 12
#  spanning-tree mst max-age 9
#  spanning-tree mst max-hops 3
#  spanning-tree mst 1 priority 2048
#  !
#  spanning-tree mst configuration
#   name mst1
#   revision 1
#   instance 1 vlan 1
#   activate
#  !
#  interface Ethernet20
#   spanning-tree bpdufilter enable
#   spanning-tree guard loop
#   spanning-tree bpduguard port-shutdown
#   spanning-tree cost 20
#   spanning-tree link-type shared
#   spanning-tree port-priority 30
#   spanning-tree port type edge
#   spanning-tree uplinkfast
#   spanning-tree mst 1 cost 60
#   spanning-tree mst 1 port-priority 65

- name: Replace STP configurations
  dellemc.enterprise_sonic.sonic_stp:
    config:
      interfaces:
        - intf_name: Ethernet20
          cost: 25
          port_priority: 35
      mstp:
        mst_name: mst2
        revision: 2
        max_hop: 4
        hello_time: 7
        max_age: 10
        fwd_delay: 13
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration spanning-tree
#  no spanning-tree vlan 4-6
#  spanning-tree mode mst
#  spanning-tree edge-port bpdufilter default
#  spanning-tree loopguard default
#  spanning-tree mst hello-time 7
#  spanning-tree mst forward-time 13
#  spanning-tree mst max-age 10
#  spanning-tree mst max-hops 4
#  !
#  spanning-tree mst configuration
#   name mst2
#   revision 2
#   activate
#  !
#  interface Ethernet20
#   spanning-tree cost 25
#   spanning-tree port-priority 35


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration spanning-tree
#  no spanning-tree vlan 4-6
#  spanning-tree mode mst
#  spanning-tree edge-port bpdufilter default
#  spanning-tree loopguard default
#  spanning-tree mst hello-time 7
#  spanning-tree mst forward-time 13
#  spanning-tree mst max-age 10
#  spanning-tree mst max-hops 4
#  !
#  spanning-tree mst configuration
#   name mst2
#   revision 2
#   activate
#  !
#  interface Ethernet20
#   spanning-tree cost 25
#   spanning-tree port-priority 35

- name: Override STP configurations
  dellemc.enterprise_sonic.sonic_stp:
    config:
      global:
        enabled_protocol: pvst
        bpdu_filter: true
        root_guard_timeout: 25
        portfast: true
        hello_time: 5
        max_age: 10
        fwd_delay: 20
        bridge_priority: 4096
      pvst:
        - vlan_id: 1
          hello_time: 4
          max_age: 6
          fwd_delay: 8
          bridge_priority: 4096
          interfaces:
            - intf_name: Ethernet20
              cost: 10
              port_priority: 50
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration spanning-tree
#  spanning-tree mode pvst
#  spanning-tree edge-port bpdufilter default
#  spanning-tree forward-time 20
#  spanning-tree guard root timeout 25
#  spanning-tree hello-time 5
#  spanning-tree max-age 10
#  spanning-tree priority 4096
#  spanning-tree portfast default
#  spanning-tree vlan 1 hello-time 4
#  spanning-tree vlan 1 forward-time 8
#  spanning-tree vlan 1 max-age 6
# sonic# show running-configuration interface Ethernet 20 | grep spanning-tree
#  spanning-tree vlan 1 cost 10
#  spanning-tree vlan 1 port-priority 50


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration spanning-tree
#  spanning-tree mode pvst
#  spanning-tree edge-port bpdufilter default
#  spanning-tree forward-time 20
#  spanning-tree guard root timeout 25
#  spanning-tree hello-time 5
#  spanning-tree max-age 10
#  spanning-tree priority 4096
#  spanning-tree portfast default
#  spanning-tree vlan 1 hello-time 4
#  spanning-tree vlan 1 forward-time 8
#  spanning-tree vlan 1 max-age 6
# sonic# show running-configuration interface Ethernet 20 | grep spanning-tree
#  spanning-tree vlan 1 cost 10
#  spanning-tree vlan 1 port-priority 50

- name: Delete STP configurations
  dellemc.enterprise_sonic.sonic_stp:
    config:
      global:
        bpdu_filter: true
        root_guard_timeout: 25
      pvst:
        - vlan_id: 1
          interfaces:
            - intf_name: Ethernet20
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration spanning-tree
# spanning-tree mode pvst
# spanning-tree forward-time 20
# spanning-tree hello-time 5
# spanning-tree max-age 10
# spanning-tree priority 4096
# spanning-tree portfast default
# spanning-tree vlan 1 hello-time 4
# spanning-tree vlan 1 forward-time 8
# spanning-tree vlan 1 max-age 6
# sonic# show running-configuration interface Ethernet 20 | grep spanning-tree
# (No spanning-tree 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_stp_module.html