Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_router_multicast — настройка многоадресной маршрутизации в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_router_multicast.

Новое в fortinet.fortios 2.0.0

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций маршрутизатора и категории многоадресной рассылки. В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных. Проверено на FOS v6.0.0

Требования

На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с указанным member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если указан member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

router_multicast

dictionary

Настройка многоадресной маршрутизации.

interface

list / elements=dictionary

Интерфейсы PIM.

bfd

string

Включить или отключить обнаружение двунаправленной переадресации (BFD) для независимой от протокола многоадресной рассылки (PIM).

Варианты:

  • "enable"
  • "disable"

cisco_exclude_genid

string

Исключить GenID из пакетов hello (для совместимости со старыми версиями Cisco IOS).

Варианты:

  • "enable"
  • "disable"

dr_priority

integer

Приоритет при выборе DR.

hello_holdtime

integer

Время до истечения срока действия сведений о старом соседе (0–65535 с).

hello_interval

integer

Интервал между отправкой сообщений PIM hello (0–65535 с).

igmp

dictionary

Параметры конфигурации IGMP.

access_group

string

Группы, к которым разрешено присоединяться узлам IGMP. Источник: router.access-list.name.

immediate_leave_group

string

Группы, членство в которых следует немедленно прекратить после получения сообщения IGMPv2 leave. Источник: router.access-list.name.

last_member_query_count

integer

Количество запросов для конкретной группы перед ее удалением (2–7).

last_member_query_interval

integer

Тайм-аут между сообщением IGMPv2 leave и удалением группы (1–65535 мс).

query_interval

integer

Интервал между запросами узлам IGMP (1–65535 с).

query_max_response_time

integer

Максимальное время ожидания ответа на запрос IGMP (1–25 с).

query_timeout

integer

Тайм-аут между запросами, после которого устройство становится узлом, отправляющим запросы для сети (60–900).

router_alert_check

string

Включить или отключить требование наличия параметра router alert в пакетах IGMP.

Варианты:

  • "enable"
  • "disable"

version

string

Максимальная поддерживаемая версия IGMP.

Варианты:

  • "3"
  • "2"
  • "1"

join_group

list / elements=dictionary

Присоединиться к группам многоадресной рассылки.

address

string / обязательный

IP-адрес группы многоадресной рассылки.

multicast_flow

string

Допустимый источник для группы многоадресной рассылки. Источник: router.multicast-flow.name.

name

string / обязательный

Имя интерфейса. Источник: system.interface.name.

neighbour_filter

string

Маршрутизаторы, признаваемые соседними. Источник: router.access-list.name.

passive

string

Включить или отключить прослушивание IGMP без участия в PIM.

Варианты:

  • "enable"
  • "disable"

pim_mode

string

Режим работы PIM.

Варианты:

  • "sparse-mode"
  • "dense-mode"

propagation_delay

integer

Задержка передачи пакетов на этом интерфейсе (100–5000 мс).

rp_candidate

string

Включить или отключить участие в выборах RP.

Варианты:

  • "enable"
  • "disable"

rp_candidate_group

string

Группы многоадресной рассылки, управляемые этим RP. Источник: router.access-list.name.

rp_candidate_interval

integer

Интервал отправки объявлений кандидата RP (1–16383 с).

rp_candidate_priority

integer

Приоритет маршрутизатора в качестве RP.

rpf_nbr_fail_back

string

Включить или отключить возврат к исходному соседу при запросе соседа RPF.

Варианты:

  • "enable"
  • "disable"

rpf_nbr_fail_back_filter

string

Фильтр соседей RPF для возврата к исходному соседу. Источник: router.access-list.name.

state_refresh_interval

integer

Интервал между отправкой пакетов обновления состояния (1–100 с).

static_group

string

Статически заданные группы многоадресной рассылки для пересылки через интерфейс. Источник: router.multicast-flow.name.

ttl_threshold

integer

Минимальное значение TTL пакетов многоадресной рассылки, которые будут пересылаться (применяется только к новым маршрутам многоадресной рассылки) (1–255).

multicast_routing

string

Включить или отключить IP-маршрутизацию многоадресной рассылки.

Варианты:

  • "enable"
  • "disable"

pim_sm_global

dictionary

Глобальные настройки PIM в режиме sparse-mode.

accept_register_list

string

Источники, которым разрешено регистрировать пакеты на этой точке встречи (RP). Источник: router.access-list.name.

accept_source_list

string

Источники, которым разрешено отправлять трафик многоадресной рассылки. Источник: router.access-list.name.

bsr_allow_quick_refresh

string

Включить или отключить прием от соседей пакетов быстрого обновления BSR.

Варианты:

  • "enable"
  • "disable"

bsr_candidate

string

Включить или отключить возможность этого маршрутизатора стать маршрутизатором начальной загрузки (BSR).

Варианты:

  • "enable"
  • "disable"

bsr_hash

integer

Длина хеша BSR (0–32).

bsr_interface

string

Интерфейс для объявления в качестве кандидата BSR. Источник: system.interface.name.

bsr_priority

integer

Приоритет BSR (0–255).

cisco_crp_prefix

string

Включить или отключить режим совместимости кандидата RP со старыми версиями Cisco IOS.

Варианты:

  • "enable"
  • "disable"

cisco_ignore_rp_set_priority

string

Использовать для выбора RP только хеш (для совместимости со старыми версиями Cisco IOS).

Варианты:

  • "enable"
  • "disable"

cisco_register_checksum

string

Вычислять контрольную сумму всего пакета register (для совместимости со старыми версиями Cisco IOS).

Варианты:

  • "enable"
  • "disable"

cisco_register_checksum_group

string

Группы, для которых вычисляется контрольная сумма Cisco register. Источник: router.access-list.name.

join_prune_holdtime

integer

Время удержания сообщений join/prune (1–65535).

message_interval

integer

Период между отправкой периодических сообщений PIM join/prune в секундах (1–65535).

null_register_retries

integer

Максимальное количество повторных отправок пустого register (1–20).

pim_use_sdwan

string

Включить или отключить использование SDWAN при проверке соседа RPF и отправке пакета REG.

Варианты:

  • "enable"
  • "disable"

register_rate_limit

integer

Ограничение количества пакетов в секунду для каждого источника, зарегистрированного через этот RP (0–65535).

register_rp_reachability

string

Включить или отключить проверку доступности RP перед регистрацией пакетов.

Варианты:

  • "enable"
  • "disable"

register_source

string

Переопределить адрес источника в пакетах register.

Варианты:

  • "disable"
  • "interface"
  • "ip-address"

register_source_interface

string

Использовать вместо него адрес основного интерфейса. Источник: system.interface.name.

register_source_ip

string

Переопределить локальным IP-адресом.

register_supression

integer

Период времени, в течение которого учитывается сообщение register-stop (1–65535 с).

rp_address

list / elements=dictionary

Статическая настройка адресов RP.

group

string

Группы, которые будут использовать эту RP. Источник: router.access-list.name.

id

integer / обязательный

ID. См. <a href=’#notes’>Примечания</a>.

ip_address

string

Адрес маршрутизатора RP.

rp_register_keepalive

integer

Тайм-аут ожидания получения данных RP по дереву (S,G) (1–65535 с).

spt_threshold

string

Включить или отключить переключение на деревья для конкретных источников.

Варианты:

  • "enable"
  • "disable"

spt_threshold_group

string

Группы, которым разрешено переключаться на дерево источника. Источник: router.access-list.name.

ssm

string

Включить или отключить многоадресную передачу для конкретного источника.

Варианты:

  • "enable"
  • "disable"

ssm_range

string

Группы, которым разрешена многоадресная передача для конкретного источника. Источник: router.access-list.name.

pim_sm_global_vrf

list / elements=dictionary

Глобальные параметры разреженного режима PIM для каждой VRF.

bsr_allow_quick_refresh

string

Включить или отключить прием пакетов быстрого обновления BSR от соседних устройств.

Варианты:

  • "enable"
  • "disable"

bsr_candidate

string

Включить или отключить возможность этому маршрутизатору стать маршрутизатором начальной загрузки (BSR).

Варианты:

  • "enable"
  • "disable"

bsr_hash

integer

Длина хеша BSR (0–32).

bsr_interface

string

Интерфейс, объявляемый кандидатом BSR. Источник: system.interface.name.

bsr_priority

integer

Приоритет BSR (0–255).

cisco_crp_prefix

string

Включить или отключить обеспечение совместимости кандидата RP со старыми версиями Cisco IOS.

Варианты:

  • "enable"
  • "disable"

rp_address

list / elements=dictionary

Статическая настройка адресов RP.

group

string

Группы, которые будут использовать эту RP. Источник: router.access-list.name.

id

integer / обязательный

ID. См. <a href=’#notes’>Примечания</a>.

ip_address

string

Адрес маршрутизатора RP.

vrf

integer / обязательный

Идентификатор VRF. См. <a href=’#notes’>Примечания</a>.

route_limit

integer

Максимальное количество маршрутов многоадресной рассылки.

route_threshold

integer

Создавать предупреждения, если количество маршрутов многоадресной рассылки превышает это значение; оно не должно быть больше route-limit.

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure router multicast.
  fortinet.fortios.fortios_router_multicast:
      vdom: "{{ vdom }}"
      router_multicast:
          interface:
              -
                  bfd: "enable"
                  cisco_exclude_genid: "enable"
                  dr_priority: "1"
                  hello_holdtime: "105"
                  hello_interval: "30"
                  igmp:
                      access_group: "<your_own_value> (source router.access-list.name)"
                      immediate_leave_group: "<your_own_value> (source router.access-list.name)"
                      last_member_query_count: "2"
                      last_member_query_interval: "1000"
                      query_interval: "125"
                      query_max_response_time: "10"
                      query_timeout: "255"
                      router_alert_check: "enable"
                      version: "3"
                  join_group:
                      -
                          address: "<your_own_value>"
                  multicast_flow: "<your_own_value> (source router.multicast-flow.name)"
                  name: "default_name_22 (source system.interface.name)"
                  neighbour_filter: "<your_own_value> (source router.access-list.name)"
                  passive: "enable"
                  pim_mode: "sparse-mode"
                  propagation_delay: "500"
                  rp_candidate: "enable"
                  rp_candidate_group: "<your_own_value> (source router.access-list.name)"
                  rp_candidate_interval: "60"
                  rp_candidate_priority: "192"
                  rpf_nbr_fail_back: "enable"
                  rpf_nbr_fail_back_filter: "<your_own_value> (source router.access-list.name)"
                  state_refresh_interval: "60"
                  static_group: "<your_own_value> (source router.multicast-flow.name)"
                  ttl_threshold: "1"
          multicast_routing: "enable"
          pim_sm_global:
              accept_register_list: "<your_own_value> (source router.access-list.name)"
              accept_source_list: "<your_own_value> (source router.access-list.name)"
              bsr_allow_quick_refresh: "enable"
              bsr_candidate: "enable"
              bsr_hash: "10"
              bsr_interface: "<your_own_value> (source system.interface.name)"
              bsr_priority: "0"
              cisco_crp_prefix: "enable"
              cisco_ignore_rp_set_priority: "enable"
              cisco_register_checksum: "enable"
              cisco_register_checksum_group: "<your_own_value> (source router.access-list.name)"
              join_prune_holdtime: "210"
              message_interval: "60"
              null_register_retries: "1"
              pim_use_sdwan: "enable"
              register_rate_limit: "0"
              register_rp_reachability: "enable"
              register_source: "disable"
              register_source_interface: "<your_own_value> (source system.interface.name)"
              register_source_ip: "<your_own_value>"
              register_supression: "60"
              rp_address:
                  -
                      group: "<your_own_value> (source router.access-list.name)"
                      id: "61"
                      ip_address: "<your_own_value>"
              rp_register_keepalive: "185"
              spt_threshold: "enable"
              spt_threshold_group: "<your_own_value> (source router.access-list.name)"
              ssm: "enable"
              ssm_range: "<your_own_value> (source router.access-list.name)"
          pim_sm_global_vrf:
              -
                  bsr_allow_quick_refresh: "enable"
                  bsr_candidate: "enable"
                  bsr_hash: "10"
                  bsr_interface: "<your_own_value> (source system.interface.name)"
                  bsr_priority: "0"
                  cisco_crp_prefix: "enable"
                  rp_address:
                      -
                          group: "<your_own_value> (source router.access-list.name)"
                          id: "77"
                          ip_address: "<your_own_value>"
                  vrf: "<you_own_value>"
          route_limit: "2147483647"
          route_threshold: ""

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи конфигурации на FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращенный FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (id), использованный при последнем обращении к FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortinet/fortios/fortios_router_multicast_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API