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

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

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

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

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

Параметры

Параметр	Комментарии
config list / elements=dictionary	Управляет конфигурациями ‘static_routes’
static_list list / elements=dictionary	Список конфигураций ‘static_routes’.
next_hops list / elements=dictionary	Список следующих переходов, используемых для указанного статического маршрута.
index dictionary / обязательный	Идентификатор, используемый для уникальной ссылки на следующий переход.
blackhole boolean	Указывает, что пакеты, соответствующие этому маршруту, следует отбрасывать. Варианты: `false` ← (по умолчанию) `true`
interface string	Ссылка на базовый интерфейс.
next_hop string	Следующий переход, используемый для статического маршрута.
nexthop_vrf string	Имя экземпляра сети следующего перехода для импортируемых маршрутов.
metric integer	Задаёт предпочтение записи следующего перехода при её добавлении в RIB.
tag integer	Значение тега статического маршрута.
track integer	Идентификатор отслеживания IP SLA для статического маршрута.
prefix string / обязательный	Префикс назначения статического маршрута IPv4 или IPv6.
vrf_name string / обязательный	Имя VRF, настроенной на устройстве.
state string	Состояние конфигурации после выполнения модуля. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"overridden"` `"replaced"`

Примечания

Примечание

Поддерживает check_mode.

Примеры

# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip route"
# (No "ip route" configuration present)

- name: Merge static routes configurations
  dellemc.enterprise_sonic.sonic_static_routes:
    config:
      - vrf_name: 'default'
        static_list:
          - prefix: '2.0.0.0/8'
            next_hops:
              - index:
                  interface: 'Ethernet4'
                metric: 1
                tag: 2
                track: 3
              - index:
                next_hop: '3.0.0.0'
                metric: 2
                tag: 4
                track: 8
      - vrf_name: 'VrfReg1'
        static_list:
          - prefix: '3.0.0.0/8'
            next_hops:
              - index:
                  interface: 'eth0'
                  nexthop_vrf: 'VrfReg2'
                  next_hop: '4.0.0.0'
                metric: 4
                tag: 5
                track: 6
              - index:
                  blackhole: true
                metric: 10
                tag: 20
                track: 30
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip route"
# ip route 2.0.0.0/8 3.0.0.0 tag 4 track 8 2
# ip route 2.0.0.0/8 interface Ethernet4 tag 2 track 3 1
# ip route vrf VrfReg1 3.0.0.0/8 4.0.0.0 interface Management 0 nexthop-vrf VrfReg2 tag 5 track 6 4
# ip route vrf VrfReg1 3.0.0.0/8 blackhole tag 20 track 30 10
#
#
# Modifying previous merge

- name: Modify static routes configurations
  dellemc.enterprise_sonic.sonic_static_routes:
    config:
      - vrf_name: 'VrfReg1'
        static_list:
          - prefix: '3.0.0.0/8'
            next_hops:
              - index:
                  blackhole: true
                metric: 11
                tag: 22
                track: 33
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip route"
# ip route 2.0.0.0/8 3.0.0.0 tag 4 track 8 2
# ip route 2.0.0.0/8 interface Ethernet4 tag 2 track 3 1
# ip route vrf VrfReg1 3.0.0.0/8 4.0.0.0 interface Management 0 nexthop-vrf VrfReg2 tag 5 track 6 4
# ip route vrf VrfReg1 3.0.0.0/8 blackhole tag 22 track 33 11


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip route"
# ip route 4.0.0.0/8 2.0.0.0 tag 4 track 8 2

- name: Override static routes configurations
  dellemc.enterprise_sonic.sonic_static_routes:
    config:
      - vrf_name: 'VrfReg2'
        static_list:
          - prefix: '3.0.0.0/8'
            next_hops:
              - index:
                  blackhole: true
                metric: 10
                tag: 20
                track: 30
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip route"
# ip route vrf VrfReg2 3.0.0.0/8 blackhole tag 20 track 30 10


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip route"
# ip route 4.0.0.0/8 2.0.0.0 tag 4 track 8 2

- name: Replace static routes configurations
  dellemc.enterprise_sonic.sonic_static_routes:
    config:
      - vrf_name: 'default'
        static_list:
          - prefix: '4.0.0.0/8'
            next_hops:
              - index:
                  blackhole: true
                metric: 5
                tag: 10
                track: 15
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip route"
# ip route 4.0.0.0/8 blackhole tag 10 track 15 5


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip route"
# ip route 2.0.0.0/8 3.0.0.0 tag 4 track 8 2
# ip route 2.0.0.0/8 interface Ethernet4 tag 2 track 3 1
# ip route vrf VrfReg1 3.0.0.0/8 4.0.0.0 interface Management 0 nexthop-vrf VrfReg2 tag 5 track 6 4
# ip route vrf VrfReg1 3.0.0.0/8 blackhole tag 22 track 33 11

- name: Delete static routes configurations
  dellemc.enterprise_sonic.sonic_static_routes:
    config:
      - vrf_name: 'default'
        static_list:
          - prefix: '2.0.0.0/8'
            next_hops:
              - index:
                  interface: 'Ethernet4'
      - vrf_name: 'VrfReg1'
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip route"
# ip route 2.0.0.0/8 3.0.0.0 tag 4 track 8 2

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

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

Ключ	Описание
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_static_routes_module.html