Модуль dellemc.enterprise_sonic.sonic_stp – Управление конфигурацией STP на SONiC

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
config dictionary	Задает конфигурации STP mstp, pvst и rapid_pvst являются взаимоисключающими.
global dictionary	Глобальная конфигурация STP
bpdu_filter boolean	Включает фильтр BPDU для портов на краю сети Варианты: `false` ← (default) `true`
bridge_priority integer	Управляемый компонент идентификатора моста Значение должно быть кратно 4096 в диапазоне от 0 до 61440 По умолчанию: `32768`
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 По умолчанию: `15`
hello_time integer	Интервал в секундах между периодическими передачами конфигурационных сообщений назначенными портами Диапазон 1-10 По умолчанию: `2`
loop_guard boolean	Настройка защиты от петель по умолчанию для моста Варианты: `false` ← (default) `true`
max_age integer	Максимальный возраст в секундах информации, передаваемой мостом, когда он является корневым мостом Диапазон 6-40 По умолчанию: `20`
portfast boolean	Включает PortFast глобально на всех портах доступа Конфигурируется для протокола pvst Варианты: `false` ← (default) `true`
root_guard_timeout integer	Указывает тайм-аут восстановления root guard в секундах, прежде чем порт будет возвращен в состояние пересылки Диапазон 5-600
interfaces list / elements=dictionary	Конфигурация STP интерфейсов
bpdu_filter boolean	Включает фильтр BPDU для портов на краю сети Варианты: `false` ← (default) `true`
bpdu_guard boolean	Включает защиту от BPDU для портов на краю сети Варианты: `false` ← (default) `true`
cost integer	Вклад порта, когда он является корневым портом, в стоимость корневого пути для моста
edge_port boolean	Настроить интерфейс как граничный порт STP Варианты: `false` ← (default) `true`
guard string	Включает root guard или loop guard Варианты: `"loop"` `"root"` `"none"`
intf_name string / required	Имя интерфейса

link_type string	Задаёт тип канала интерфейса Choices: `"point-to-point"` `"shared"`
port_priority integer	Управляемый компонент идентификатора порта Диапазон 0-240
portfast boolean	Включить/Выключить portfast на указанном интерфейсе Конфигурируемый для протокола pvst Choices: `false` ← (default) `true`
shutdown boolean	Порт, который будет выключен при получении BPDU Choices: `false` ← (default) `true`
stp_enable boolean	Включает STP на интерфейсе Choices: `false` `true` ← (default)
uplink_fast boolean	Включает uplink fast Choices: `false` ← (default) `true`
mstp dictionary	Конфигурация Multi STP
fwd_delay integer	Задержка в секундах, используемая мостами STP для перевода корневых и назначенных портов в режим пересылки Диапазон 4-30
hello_time integer	Интервал в секундах между периодическими передачами сообщений конфигурации назначенными портами Диапазон 1-10
max_age integer	Максимальный возраст в секундах информации, передаваемой мостом, когда он является корневым мостом Диапазон 6-40
max_hop integer	Количество мостов в регионе MST, которые может пройти BPDU, прежде чем он будет отброшен
mst_instances list / elements=dictionary	Конфигурация для экземпляров MST
bridge_priority integer	Управляемый компонент идентификатора моста Значение должно быть кратным 4096
interfaces list / elements=dictionary	Список интерфейсов с включенным STP
cost integer	Вклад порта, когда он является корневым портом, в стоимость корневого пути для моста
intf_name string / required	Ссылка на интерфейс STP
port_priority integer	Управляемый компонент идентификатора порта
mst_id integer / required	Значение, используемое для идентификации экземпляра MST
vlans list / elements=string	Список VLAN, сопоставленных с экземпляром MST. Значение элемента списка может быть одним идентификатором VLAN или диапазоном идентификаторов VLAN разделённых ‘-’ или ‘..’; например 70-100 или 70..100.
mst_name string	Имя идентификатора конфигурации MST
revision integer	Уровень пересмотра идентификатора конфигурации MST
pvst list / elements=dictionary	Конфигурация STP на уровне VLAN

bridge_priority integer	Управляемый компонент идентификатора моста Значение должно быть кратно 4096
fwd_delay integer	Задержка в секундах, используемая мостами STP для перевода корневых и назначенных портов в режим пересылки Диапазон 4-30
hello_time integer	Интервал в секундах между периодическими передачами сообщений конфигурации назначенными портами Диапазон 1-10
interfaces list / elements=dictionary	Список интерфейсов с включенным STP
cost integer	Вклад порта, когда он является корневым портом, в стоимость корневого пути для моста
intf_name string / required	Ссылка на интерфейс STP
port_priority integer	Управляемый компонент идентификатора порта
max_age integer	Максимальный возраст в секундах информации, передаваемой мостом, когда он является корневым мостом Диапазон 6-40
vlan_id integer / required	Идентификатор VLAN
rapid_pvst list / elements=dictionary	Конфигурация Rapid per VLAN STP
bridge_priority integer	Управляемый компонент идентификатора моста Значение должно быть кратно 4096
fwd_delay integer	Задержка в секундах, используемая мостами STP для перевода корневых и назначенных портов в режим пересылки Диапазон 4-30
hello_time integer	Интервал в секундах между периодическими передачами сообщений конфигурации назначенными портами Диапазон 1-10
interfaces list / elements=dictionary	Список интерфейсов с включенным STP
cost integer	Вклад порта, когда он является корневым портом, в стоимость корневого пути для моста
intf_name string / required	Ссылка на интерфейс STP
port_priority integer	Управляемый компонент идентификатора порта
max_age integer	Максимальный возраст в секундах информации, передаваемой мостом, когда он является корневым мостом Диапазон 6-40
vlan_id integer / required	Идентификатор VLAN
state string	Состояние конфигурации после завершения работы модуля Варианты: `"merged"` ← (default) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

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

Примеры

# Using merged
#
# 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
#
# 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
#
# 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
#
# 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 список / элементы=строка	Вызов модуля конфигурации в результате. Возвращается: при изменении Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
after(generated) список / элементы=строка	Вызов модуля сгенерированной конфигурации. Возвращается: когда `check_mode` Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
before список / элементы=строка	Конфигурация до вызова модуля. Возвращается: всегда Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
commands список / элементы=строка	Набор команд, отправленных на удаленное устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

Shade Talabi (@stalabi1)

Ссылки на сборку

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