Модуль dellemc.enterprise_sonic.sonic_pim_interfaces — управление настройками PIM для отдельных интерфейсов в 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_pim_interfaces.

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

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

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

Этот модуль позволяет управлять настройками PIM для отдельных интерфейсов устройств под управлением SONiC.
Профили BFD необходимо предварительно создать на устройстве.

Параметры

Параметр	Комментарии
config list / elements=dictionary	Указывает настройки PIM для отдельных интерфейсов.
bfd_enable boolean	Включает поддержку BFD для PIM. Варианты: `false` `true`
bfd_profile string	Указывает профиль BFD для включения. Для настройки профиля BFD необходимо включить поддержку BFD для PIM.
drpriority integer	Указывает приоритет назначенного маршрутизатора. Диапазон значений: от 1 до 4294967295.
hello_interval integer	Указывает интервал отправки Hello в секундах. Диапазон значений: от 1 до 255.
name string / обязательный	Полное имя интерфейса.
sparse_mode boolean	Включает разреженный режим PIM. Варианты: `false` `true`
state string	Состояние конфигурации после выполнения модуля. `merged` — объединяет предоставленную конфигурацию PIM для отдельных интерфейсов с конфигурацией на устройстве. `replaced` — заменяет конфигурацию PIM указанных интерфейсов на устройстве предоставленной конфигурацией. `overridden` — переопределяет все настройки PIM для отдельных интерфейсов на устройстве предоставленной конфигурацией. `deleted` — удаляет конфигурацию PIM для отдельных интерфейсов на устройстве. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

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

Примеры

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim sparse-mode
#  ip pim drpriority 10
#  ip pim hello 60
#  ip pim bfd
#  ip pim bfd profile profile_1
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
#  ip pim hello 60
#  ip pim bfd
# sonic#

- name: Delete specified interface PIM configurations
  dellemc.enterprise_sonic.sonic_pim_interfaces:
    config:
      - name: 'Eth1/1'
        hello_interval: 60
        bfd_profile: profile_1
      - name: 'Eth1/2'
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim sparse-mode
#  ip pim drpriority 10
#  ip pim bfd
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
# sonic#


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim sparse-mode
#  ip pim drpriority 10
#  ip pim hello 60
#  ip pim bfd
#  ip pim bfd profile profile_1
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
#  ip pim hello 60
#  ip pim bfd
# sonic#

- name: Delete all interface-specific PIM configurations
  dellemc.enterprise_sonic.sonic_pim_interfaces:
    config:
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
# sonic#


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim sparse-mode
#  ip pim hello 45
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
# sonic#

- name: Merge provided interface PIM configurations
  dellemc.enterprise_sonic.sonic_pim_interfaces:
    config:
      - name: 'Eth1/1'
        drpriority: 10
        hello_interval: 60
        bfd_enable: true
        bfd_profile: profile_1
      - name: 'Eth1/2'
        hello_interval: 60
        bfd_enable: true
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim sparse-mode
#  ip pim drpriority 10
#  ip pim hello 60
#  ip pim bfd
#  ip pim bfd profile profile_1
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
#  ip pim hello 60
#  ip pim bfd
# sonic#


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim sparse-mode
#  ip pim drpriority 10
#  ip pim hello 45
#  ip pim bfd
#  ip pim bfd profile profile_1
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
#  ip pim hello 60
#  ip pim bfd
# sonic#

- name: Replace PIM configurations for specified interfaces
  dellemc.enterprise_sonic.sonic_pim_interfaces:
    config:
      - name: 'Eth1/1'
        hello_interval: 60
        bfd_enable: true
        bfd_profile: profile_1
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim hello 60
#  ip pim bfd
#  ip pim bfd profile profile_1
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
#  ip pim hello 60
#  ip pim bfd
# sonic#


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim sparse-mode
#  ip pim drpriority 10
#  ip pim hello 45
#  ip pim bfd
#  ip pim bfd profile profile_1
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
#  ip pim hello 60
#  ip pim bfd
# sonic#

- name: Override interface-specific PIM configurations
  dellemc.enterprise_sonic.sonic_pim_interfaces:
    config:
      - name: 'Eth1/1'
        hello_interval: 60
        bfd_enable: true
        bfd_profile: profile_1
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration interface Eth 1/1 | grep "ip pim"
#  ip pim hello 60
#  ip pim bfd
#  ip pim bfd profile profile_1
# sonic# show running-configuration interface Eth 1/2 | grep "ip pim"
# sonic#

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

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

Ключ	Описание
after list / elements=string	Итоговая конфигурация при вызове модуля. Возвращается: при изменении Пример: `["The configuration returned will always be in the same format\n as the parameters above.\n"]`
after(generated) list / elements=string	Сгенерированная конфигурация при вызове модуля. Возвращается: когда `check_mode` Пример: `["The configuration returned will always be in the same format\n as the parameters above.\n"]`
before list / elements=string	Конфигурация до вызова модуля. Возвращается: always Пример: `["The configuration returned will always be in the same format\n as the parameters above.\n"]`
commands list / elements=string	Набор команд, отправленных на удалённое устройство. Возвращается: always Пример: `["command 1", "command 2", "command 3"]`

Авторы

Arun Saravanan Balachandran (@ArunSaravananBalachandran)

Ссылки на коллекцию

© 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_pim_interfaces_module.html