Spec-Zone.ru › Ansible

fortinet.fortios.fortios_router_multicast модуль — Настройка маршрутизатора multicast в FortiOS и FortiGate Fortinet.

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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), позволяя пользователю устанавливать и изменять параметры маршрутизатора и категорию multicast. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

string

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

enable_log

boolean

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

Варианты:

  • false ← (default)
  • true

member_path

string

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

Разделяется символом слеша, если атрибутов больше одного.

Параметр, помеченный как member_path, является допустимым для выполнения операции с участником.

member_state

string

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

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

Варианты:

  • "present"
  • "absent"

router_multicast

dictionary

Настроить маршрутизацию multicast.

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

Включить/выключить требование, чтобы пакеты IGMP содержали параметр предупреждения маршрутизатора.

Варианты:

  • "enable"
  • "disable"

version

string

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

Варианты:

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

join_group

list / elements=dictionary

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

address

string / required

IP-адрес мультикаст-группы.

multicast_flow

string

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

name

string / required

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

neighbour_filter

string

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

passive

string

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

Choices:

  • "enable"
  • "disable"

pim_mode

string

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

Choices:

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

propagation_delay

integer

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

rp_candidate

string

Включить/отключить конкуренцию за роль RP на выборах.

Choices:

  • "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.

Choices:

  • "enable"
  • "disable"

rpf_nbr_fail_back_filter

string

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

state_refresh_interval

integer

Интервал между отправкой пакетов state-refresh (1 - 100 сек).

static_group

string

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

ttl_threshold

integer

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

multicast_routing

string

Включить/отключить IP-маршрутизацию мультикаста.

Choices:

  • "enable"
  • "disable"

pim_sm_global

dictionary

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

accept_register_list

string

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

accept_source_list

string

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

bsr_allow_quick_refresh

string

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

Choices:

  • "enable"
  • "disable"

bsr_candidate

string

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

Choices:

  • "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.

Choices:

  • "enable"
  • "disable"

cisco_ignore_rp_set_priority

string

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

Choices:

  • "enable"
  • "disable"

cisco_register_checksum

string

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

Choices:

  • "enable"
  • "disable"

cisco_register_checksum_group

string

Контрольная сумма Cisco только для этих групп. Источник router.access-list.name.

join_prune_holdtime

integer

Время ожидания Join/prune (1 - 65535).

message_interval

integer

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

null_register_retries

integer

Максимальное количество попыток null register (1 - 20).

pim_use_sdwan

string

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

Choices:

  • "enable"
  • "disable"

register_rate_limit

integer

Лимит пакетов/сек на источник, зарегистрированный через этот RP (0 - 65535).

register_rp_reachability

string

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

Choices:

  • "enable"
  • "disable"

register_source

string

Переопределить исходный адрес в пакетах регистрации.

Choices:

  • "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 / required

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

Группы, разрешённые для переключения на дерево, основанное на источнике. Имя списка доступа маршрутизатора-источника.

ssm

string

Включить/выключить многоадресную рассылку, основанную на конкретных источниках.

Варианты:

  • "enable"
  • "disable"

ssm_range

string

Группы, разрешённые для многоадресной рассылки, основанной на конкретных источниках. Имя списка доступа маршрутизатора-источника.

route_limit

integer

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

route_threshold

integer

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

vdom

string

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

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

Примечания

Примечание

  • Модуль fortiosapi устарел, httpapi предпочтительнее для выполнения playbooks

Примеры

- 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)"
          route_limit: "2147483647"
          route_threshold: ""

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

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

Ключ

Описание

build

строка

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

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

Пример: "1547"

http_method

строка

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

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

Пример: "PUT"

http_status

строка

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

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

Пример: "200"

mkey

строка

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

Возвращается: успех

Пример: "id"

name

строка

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

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

строка

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

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

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

Пример: "success"

vdom

строка

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

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

Пример: "root"

version

строка

Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_router_multicast_module.html

Spec-Zone.ru

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