Модуль dellemc.enterprise_sonic.sonic_fbs_groups — управление конфигурацией групп служб на основе потоков (FBS) в 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_fbs_groups.

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

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

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

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

Параметры

Параметр	Комментарии
config dictionary	Конфигурация групп FBS
next_hop_groups list / elements=dictionary	Конфигурация групп следующих переходов
group_description string	Описание группы следующих переходов
group_name string / обязательный	Имя группы следующих переходов
group_type string	Тип группы следующих переходов Тип группы необходимо указывать для состояний merged, replaced и overridden. Варианты: `"ipv4"` `"ipv6"`
next_hops list / elements=dictionary	Конфигурация следующих переходов для пересылки
entry_id integer / обязательный	Идентификатор записи, диапазон 1–65535
ip_address string	IP-адрес для пересылки IP-адрес необходимо указывать для состояний merged, replaced и overridden.
next_hop_type string	Тип следующего перехода Варианты: `"non_recursive"` `"overlay"` `"recursive"`
vrf string	Сетевой экземпляр для пересылки
threshold_down integer	Задает пороговое значение, равное которому или меньше которого следующий переход не считается пригодным для пересылки Диапазон 0–127 Необходимо настроить threshold_type.
threshold_type string	Тип порогового значения При удалении threshold_type будут удалены threshold_up и threshold_down. Варианты: `"count"` `"percentage"`
threshold_up integer	Задает минимальное пороговое значение, при котором группа следующих переходов считается пригодной для пересылки Диапазон 1–128 Необходимо настроить threshold_type.
replication_groups list / elements=dictionary	Конфигурация групп репликации
group_description string	Описание группы репликации
group_name string / обязательный	Имя группы репликации
group_type string	Тип группы репликации Тип группы необходимо указывать для состояний merged, replaced и overridden. Варианты: `"ipv4"` `"ipv6"`
next_hops list / elements=dictionary	Конфигурация следующих переходов для пересылки
entry_id integer / обязательный	Идентификатор записи, диапазон 1–65535
ip_address string	IP-адрес для пересылки IP-адрес необходимо указывать для состояний merged, replaced и overridden.
next_hop_type string	Тип следующего перехода Варианты: `"non_recursive"` `"overlay"` `"recursive"`
single_copy boolean	Включить/отключить использование одного пути для создания копии Варианты: `false` `true`
vrf string	Сетевой экземпляр для пересылки
state string	Состояние конфигурации после завершения работы модуля Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

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

Примеры

# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration pbf next-hop-group
# (No 'pbf next-hop-group' configuration present)
# sonic# show running-configuration pbf replication-group
# (No 'pbf replication-group' configuration present)

- name: Merge FBS groups configuration
  dellemc.enterprise_sonic.sonic_fbs_groups:
    config:
      next_hop_groups:
        - group_name: hop1
          group_description: abc
          group_type: ipv4
          threshold_type: count
          threshold_up: 15
          threshold_down: 5
          next_hops:
            - entry_id: 1
              ip_address: 1.1.1.1
              vrf: VrfReg1
              next_hop_type: non_recursive
      replication_groups:
        - group_name: rep1
          group_description: xyz
          group_type: ipv6
          next_hops:
            - entry_id: 2
              ip_address: 1::1
              vrf: VrfReg2
              next_hop_type: overlay
              single_copy: true
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration pbf next-hop-group
# !
# pbf next-hop-group hop1 type ip
#   description abc
#   threshold type count up 15 down 5
#   entry 1 next-hop 1.1.1.1 vrf VrfReg1 non-recursive
# !
# sonic# show running-configuration pbf replication-group
# !
# pbf replication-group rep1 type ipv6
#   description xyz
#   entry 2 next-hop 1::1 vrf VrfReg2 overlay single-copy
# !


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration pbf next-hop-group
# !
# pbf next-hop-group hop1 type ip
#   description abc
#   threshold type count up 15 down 5
#   entry 1 next-hop 1.1.1.1 vrf VrfReg1 non-recursive
# !
# pbf next-hop-group hop2 type ipv6
#   description abc
#   entry 5 next-hop 3::3 vrf default non-recursive
# !
# sonic# show running-configuration pbf replication-group
# !
# pbf replication-group rep1 type ipv6
#   description xyz
#   entry 2 next-hop 1::1 vrf VrfReg2 overlay single-copy
# !

- name: Replace FBS groups configuration
  dellemc.enterprise_sonic.sonic_fbs_groups:
    config:
      next_hop_groups:
        - group_name: hop2
          group_description: xyz
          group_type: ipv4
          next_hops:
            - entry_id: 1
              ip_address: 1.1.1.1
              vrf: VrfReg1
              next_hop_type: recursive
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration pbf next-hop-group
# !
# pbf next-hop-group hop1 type ip
#   description abc
#   threshold type count up 15 down 5
#   entry 1 next-hop 1.1.1.1 vrf VrfReg1 non-recursive
# !
# pbf next-hop-group hop2 type ipv4
#   description xyz
#   entry 1 next-hop 1.1.1.1 vrf VrfReg1 recursive
# !
# sonic# show running-configuration pbf replication-group
# !
# pbf replication-group rep1 type ipv6
#   description xyz
#   entry 2 next-hop 1::1 vrf VrfReg2 overlay single-copy
# !


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration pbf next-hop-group
# !
# pbf next-hop-group hop1 type ip
#   description abc
#   entry 1 next-hop 1.1.1.1 vrf VrfReg1 non-recursive
# !
# sonic# show running-configuration pbf replication-group
# !
# pbf replication-group rep1 type ipv6
#   description xyz
#   entry 2 next-hop 1::1 vrf VrfReg2 overlay single-copy
# !

- name: Override FBS groups configuration
  dellemc.enterprise_sonic.sonic_fbs_groups:
    config:
      next_hop_groups:
        - group_name: hop1
          group_description: abc
          group_type: ipv4
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration pbf next-hop-group
# !
# pbf next-hop-group hop1 type ip
#   description abc
# !
# sonic# show running-configuration pbf replication-group
# (No 'pbf replication-group' configuration present)


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration pbf next-hop-group
# !
# pbf next-hop-group hop1 type ip
#   description abc
#   entry 1 next-hop 1.1.1.1 vrf VrfReg1 non-recursive
# !
# sonic# show running-configuration pbf replication-group
# !
# pbf replication-group rep1 type ipv6
#   description xyz
#   entry 2 next-hop 1::1 vrf VrfReg2 overlay single-copy
# !

- name: Delete FBS groups configuration
  dellemc.enterprise_sonic.sonic_fbs_groups:
    config:
      next_hop_groups:
        - group_name: hop1
          group_description: abc
      replication_groups:
        - group_name: rep1
          next_hops:
            - entry_id: 2
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration pbf next-hop-group
# !
# pbf next-hop-group hop1 type ip
#   entry 1 next-hop 1.1.1.1 vrf VrfReg1 non-recursive
# !
# sonic# show running-configuration pbf replication-group
# !
# pbf replication-group rep1 type ipv6
#   description xyz
# !


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration pbf next-hop-group
# !
# pbf next-hop-group hop1 type ip
#   entry 1 next-hop 1.1.1.1 vrf VrfReg1 non-recursive
# !
# sonic# show running-configuration pbf replication-group
# !
# pbf replication-group rep1 type ipv6
#   description xyz
# !

- name: Delete FBS groups configuration
  dellemc.enterprise_sonic.sonic_fbs_groups:
    config:
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration pbf next-hop-group
# (No 'pbf next-hop-group' configuration present)
# sonic# show running-configuration pbf replication-group
# (No 'pbf replication-group' configuration present)

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

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

Ключ	Описание
after dictionary	Конфигурация, полученная в результате вызова модуля. Возвращается: при наличии изменений
after(generated) dictionary	Конфигурация, созданная при вызове модуля. Возвращается: при `check_mode`
before dictionary	Конфигурация до вызова модуля. Возвращается: всегда
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_fbs_groups_module.html