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

Новое в dellemc.enterprise_sonic 2.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

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

Примечания

Примечание

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

Примеры

# Using merged
#
# 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
#
# 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
#
# 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
#
# 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

END_OF_DOCUMENT_MARKER

Значения возврата

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

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