модуль dellemc.enterprise_sonic.sonic_fbs_policies — управление конфигурацией политик сервисов на основе потоков (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_policies.

Новое в dellemc.enterprise_sonic 3.1.0

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

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

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

Параметры

Параметр	Комментарии
config list / elements=dictionary	Конфигурация политик FBS
policy_description string	Описание политики
policy_name string / обязательный	Имя политики
policy_type string	Тип политики Варианты: `"acl-copp"` `"copp"` `"forwarding"` `"monitoring"` `"qos"`
sections list / elements=dictionary	Конфигурация разделов политики
acl_copp dictionary	Конфигурация ACL CoPP Для имен политик, назначаемых пользователем, параметру policy_type необходимо задать значение `acl-copp` или `copp` для policy_name = copp-system-policy
cpu_queue_index integer	Индекс очереди CPU, диапазон 0–31
policer dictionary	Конфигурация ограничения трафика
cbs integer	Размер гарантированного всплеска, измеряемый в Bps, диапазон 1–4294967295
cir integer	Гарантированная скорость передачи данных, измеряемая в bps, диапазон 1–4294967295
pbs integer	Размер пикового всплеска, измеряемый в Bps, диапазон 1–4294967295
pir integer	Пиковая скорость передачи данных, измеряемая в bps, диапазон 1–4294967295
class string / обязательный	Имя классификатора
forwarding dictionary	Конфигурация действий по пересылке Для параметра policy_type необходимо задать значение `forwarding`
ars_disable boolean	Включение или отключение пересылки с адаптивной маршрутизацией и коммутацией Функциональное значение по умолчанию: `false` Варианты: `false` `true`
egress_interfaces list / elements=dictionary	Конфигурация выходных интерфейсов
intf_name string / обязательный	Имя интерфейса
priority integer	Приоритет выходных интерфейсов, выбираемых для пересылки, диапазон 1–65535
next_hop_groups list / elements=dictionary	Конфигурация групп следующих переходов для пересылки L3
group_name string / обязательный	Имя группы следующих переходов
group_type string	Тип группы следующих переходов Варианты: `"ipv4"` `"ipv6"`
priority integer	Приоритет группы следующих переходов, выбираемой для пересылки, диапазон 1–65535
next_hops list / elements=dictionary	Конфигурация следующих переходов для пересылки L3
address string / обязательный	IP-адрес или IPv6-адрес для пересылки
priority integer	Приоритет следующего перехода, выбираемого для пересылки, диапазон 1–65535
vrf string	Сетевой экземпляр для пересылки
replication_groups list / elements=dictionary	Конфигурация групп репликации для пересылки L3
group_name string / обязательный	Имя группы репликации
group_type string	Тип группы репликации Варианты: `"ipv4"` `"ipv6"`
priority integer	Приоритет группы репликации, выбираемой для пересылки, диапазон 1–65535
mirror_sessions list / elements=dictionary	Конфигурация сеансов зеркалирования Для параметра policy_type необходимо задать значение `monitoring`
session_name string / обязательный	Имя сеанса зеркалирования
priority integer	Приоритет потока в политике, диапазон 0–4095
qos dictionary	Конфигурация действий QoS Для параметра policy_type необходимо задать значение `qos`
output_queue_index integer	Индекс выходной очереди, диапазон 0–7
policer dictionary	Конфигурация ограничения трафика
cbs integer	Размер гарантированного всплеска, измеряемый в Bps, диапазон 1–4294967295
cir integer	Гарантированная скорость передачи данных, измеряемая в bps, диапазон 1–4294967295
pbs integer	Размер пикового всплеска, измеряемый в Bps, диапазон 1–4294967295
pir integer	Пиковая скорость передачи данных, измеряемая в bps, диапазон 1–4294967295
remark dictionary	Конфигурация изменения меток
set_dot1p integer	Значение метки Dot1p, диапазон 0–7
set_dscp integer	Значение метки DSCP, диапазон 0–63
section_description string	Описание раздела
state string	Состояние конфигурации после выполнения модуля Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

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

Примеры

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

- name: Merge FBS policies configuration
  dellemc.enterprise_sonic.sonic_fbs_policies:
    config:
      - policy_name: policy1
        policy_description: abc
        policy_type: forwarding
        sections:
          - class: class1
            forwarding:
              ars_disable: true
              egress_interfaces:
                - intf_name: Ethernet96
                  priority: 1
            priority: 0
            section_description: xyz
      - policy_name: policy2
        policy_description: qwerty
        policy_type: acl-copp
        sections:
          - class: class1
            acl_copp:
              cpu_queue_index: 0
              policer:
                cbs: 80
                cir: 75
                pbs: 95
                pir: 96
            priority: 0
      - policy_name: policy3
        policy_description: 'this is policy 3'
        policy_type: qos
        sections:
          - class: class1
            qos:
              output_queue_index: 0
              policer:
                cbs: 15
                cir: 20
                pbs: 21
                pir: 24
              remark:
                set_dot1p: 0
                set_dscp: 0
            priority: 0
      - policy_name: policy4
        policy_description: 'this is policy 4'
        policy_type: monitoring
        sections:
          - class: class1
            mirror_sessions:
              - session_name: session1
            priority: 0
      - policy_name: policy5
        policy_description: abc
        policy_type: forwarding
        sections:
          - class: class1
            forwarding:
              next_hops:
                - address: 1.1.1.1
                  vrf: default
                  priority: 1
              next_hop_groups:
                - group_name: hop1
                  group_type: ipv4
                  priority: 1
              replication_groups:
                - group_name: rep1
                  group_type: ipv4
                  priority: 1
            priority: 0
            section_description: 'section for class1'
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration policy-map
# !
# policy-map policy1 type forwarding
#  description abc
#  class class1 priority 0
#  description xyz
#   set interface Ethernet96 priority 1
#   set ars disable
#  !
# !
# policy-map policy2 type acl-copp
#  description qwerty
#  class class1 priority 0
#   set trap-queue 0
#   police cir 75 cbs 80 pir 96 pbs 95
#  !
# !
# policy-map policy3 type qos
#  description "this is policy 3"
#  class class1 priority 0
#   set pcp 0
#   set dscp 0
#   set traffic-class 0
#   police cir 20 cbs 15 pir 24 pbs 21
#  !
# !
# policy-map policy4 type monitoring
#  description "this is policy 4"
#  class class1 priority 0
#   set mirror-session session1
#  !
# !
# policy-map policy5 type forwarding
#  description abc
#  class class1 priority 0
#  description "section for class1"
#   set ip next-hop 1.1.1.1 vrf default priority 1
#   set ip next-hop-group hop1 priority 1
#   set ip replication-group rep1 priority 1
#  !


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration policy-map
# !
# policy-map policy1 type forwarding
#  description abc
#  class class1 priority 0
#  description xyz
#   set interface Ethernet20 priority 1
#   set ars disable
#  !
# !
# policy-map policy2 type acl-copp
#  description qwerty
#  class class1 priority 0
#   set trap-queue 0
#   police cir 75 cbs 80 pir 96 pbs 95
#  !

- name: Replace FBS policies configuration
  dellemc.enterprise_sonic.sonic_fbs_policies:
    config:
      - policy_name: policy1
        policy_description: 'abc123'
        policy_type: monitoring
        sections:
          - class: class1
            mirror_sessions:
              - session_name: mirror1
            priority: 0
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration policy-map
# !
# policy-map policy1 type monitoring
#  description "abc123"
#  class class1 priority 0
#   set mirror-session mirror1
#  !
# !
# policy-map policy2 type acl-copp
#  description qwerty
#  class class1 priority 0
#   set trap-queue 0
#   police cir 75 cbs 80 pir 96 pbs 95
#  !


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration policy-map
# !
# policy-map policy1 type forwarding
#  description abc
#  class class1 priority 0
#  description xyz
#   set interface Ethernet20 priority 1
#   set ars disable
#  !

- name: Override FBS policies configuration
  dellemc.enterprise_sonic.sonic_fbs_policies:
    config:
      - policy_name: policy2
        policy_description: qwerty
        policy_type: copp
        sections:
          - class: class1
            acl_copp:
              cpu_queue_index: 0
              policer:
                cbs: 80
                cir: 75
                pbs: 95
                pir: 96
            priority: 0
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration policy-map
# !
# policy-map policy2 type acl-copp
#  description qwerty
#  class class1 priority 0
#   set trap-queue 0
#   police cir 75 cbs 80 pir 96 pbs 95
#  !


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration policy-map
# !
# policy-map policy1 type forwarding
#  description abc
#  class class1 priority 0
#  description xyz
#   set interface Ethernet20 priority 1
#   set ars disable
#  !
# !
# policy-map policy2 type acl-copp
#  description qwerty
#  class class1 priority 0
#   set trap-queue 0
#   police cir 75 cbs 80 pir 96 pbs 95
#  !
# !
# policy-map policy3 type monitoring
#  description "this is policy 3"
#  class class1 priority 0
#   set mirror-session mirror1
#  !

- name: Delete FBS policies configuration
  dellemc.enterprise_sonic.sonic_fbs_policies:
    config:
      - policy_name: policy1
      - policy_name: policy2
        sections:
          - class: class1
            acl_copp:
              policer:
                cbs: 80
                cir: 75
                pbs: 95
                pir: 96
      - policy_name: policy3
        sections:
          - class: class1
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration policy-map
# !
# policy-map policy2 type acl-copp
#  description qwerty
#  class class1 priority 0
#   set trap-queue 0
#  !
# !
# policy-map policy3 type monitoring
#  description "this is policy 3"
#  !


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration policy-map
# !
# policy-map policy2 type acl-copp
#  description qwerty
#  class class1 priority 0
#   set trap-queue 0
#  !
# !
# policy-map policy3 type monitoring
#  description "this is policy 3"
#  !

- name: Delete all FBS policies configuration
  dellemc.enterprise_sonic.sonic_fbs_policies:
    config:
    state: deleted

# After state:
# -------------
#
# sonic# show running-configuration policy-map
# (No policy-map configuration present)

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

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

Ключ	Описание
after list / elements=string	Конфигурация, полученная в результате вызова модуля. Возвращается: при изменении
after(generated) list / elements=string	Конфигурация, сгенерированная в результате вызова модуля. Возвращается: если `check_mode`
before list / elements=string	Конфигурация до вызова модуля. Возвращается: всегда
commands list / elements=string	Набор команд, отправленных на удаленное устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

1. S. 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_policies_module.html