Spec-Zone.ru › Ansible 2.11

fortinet.fortios.fortios_router_multicast – Настройка маршрутизации multicast в FortiOS и FortiGate Fortinet.

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Для использования в плейбуке укажите: fortinet.fortios.fortios_router_multicast.

Новое в версии 2.8: of fortinet.fortios

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Описание

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

Требования

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

  • ansible>=2.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_token
строка
Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate.
router_multicast
словарь
Настройка маршрутизации мультикаста.
interface
список / элементы=строка
Интерфейсы PIM.
bfd
строка
    Варианты:
  • включить
  • выключить
Включить/выключить обнаружение двустороннего прохождения (BFD) для протокола независимого от протокола (PIM).
cisco_exclude_genid
строка
    Варианты:
  • включить
  • выключить
Исключить GenID из пакетов hello (совместимость со старыми Cisco IOS).
dr_priority
целое число
Приоритет выбора DR.
hello_holdtime
целое число
Время, через которое устаревает информация о старом соседе (0-65535 сек).
hello_interval
целое число
Интервал между отправкой сообщений PIM hello (0-65535 сек).
igmp
словарь
Настройки конфигурации IGMP.
access_group
строка
Группы, которым разрешено присоединяться к IGMP-хостам. Имя списка доступа маршрутизатора-источника.
immediate_leave_group
строка
Группы, членство в которых должно быть немедленно прекращено после получения сообщения IGMPv2 о выходе. Имя списка доступа маршрутизатора-источника.
last_member_query_count
целое число
Количество запросов к группе до удаления группы (2-7).
last_member_query_interval
целое число
Тайм-аут между выходом из IGMPv2-группы и удалением группы (1-65535 мс).
query_interval
целое число
Интервал между запросами к IGMP-хостам (1-65535 сек).
query_max_response_time
целое число
Максимальное время ожидания ответа на запрос IGMP (1-25 сек).
query_timeout
целое число
Тайм-аут между запросами до назначения себя инициатором запроса для сети (60-900).
router_alert_check
строка
    Варианты:
  • включить
  • выключить
Включить/выключить требование, чтобы пакеты IGMP содержали опцию router alert.
version
строка
    Варианты:
  • 3
  • 2
  • 1
Максимальная поддерживаемая версия IGMP.
join_group
список / элементы=строка
Присоединение к группам мультикаста.
address
строка / обязательно
IP-адрес группы мультикаста.
multicast_flow
строка
Допустимые источники для группы мультикаста. Имя потока мультикаста маршрутизатора-источника.
name
строка / обязательно
Имя интерфейса. Имя интерфейса источника.
neighbour_filter
строка
Маршрутизаторы, признанные соседними маршрутизаторами. Имя списка доступа маршрутизатора-источника.
passive
строка
    Варианты:
  • включить
  • выключить
Включить/выключить прослушивание IGMP, но без участия в PIM.
pim_mode
строка
    Варианты:
  • разреженный режим
  • плотный режим
Режим работы PIM.
propagation_delay
целое число
Задержка распространения пакетов по этому интерфейсу (100-5000 мс).
rp_candidate
строка
    Варианты:
  • включить
  • выключить
Включить/выключить участие в выборах для назначения себя в качестве RP.
rp_candidate_group
строка
Группы мультикаста, управляемые этим RP. Имя списка доступа маршрутизатора-источника.
rp_candidate_interval
целое число
Интервал объявления кандидата в RP (1-16383 сек).
rp_candidate_priority
целое число
Приоритет маршрутизатора как RP.
state_refresh_interval
целое число
Интервал между отправкой пакетов обновления состояния (1-100 сек).
static_group
строка
Статически заданные группы мультикаста для пересылки извне. Имя потока мультикаста маршрутизатора-источника.
ttl_threshold
целое число
Минимальное значение TTL пакетов мультикаста, которые будут пересылаться (применимо только к новым маршрутам мультикаста) (1-255).
multicast_routing
строка
    Варианты:
  • включить
  • выключить
Включить/выключить маршрутизацию IP мультикаста.
pim_sm_global
словарь
Глобальные настройки PIM разреженного режима.
accept_register_list
строка
Источники, которым разрешено регистрировать пакеты в этом Rendezvous Point (RP). Имя списка доступа маршрутизатора-источника.
accept_source_list
строка
Источники, которым разрешено отправлять трафик мультикаста. Имя списка доступа маршрутизатора-источника.
bsr_allow_quick_refresh
строка
    Варианты:
  • включить
  • выключить
Включить/выключить принятие пакетов быстрого обновления BSR от соседей.
bsr_candidate
строка
    Варианты:
  • включить
  • выключить
Включить/выключить возможность этого маршрутизатора стать маршрутизатором BSR (bootstrap).
bsr_hash
целое число
Длина хеша BSR (0-32).
bsr_interface
строка
Интерфейс для объявления в качестве кандидата в BSR. Имя интерфейса маршрутизатора-источника.
bsr_priority
целое число
Приоритет BSR (0-255).
cisco_crp_prefix
строка
    Варианты:
  • включить
  • выключить
Включить/выключить совместимость кандидата RP со старой Cisco IOS.
cisco_ignore_rp_set_priority
строка
    Варианты:
  • включить
  • выключить
Использовать только хэш для выбора RP (совместимость со старой Cisco IOS).
cisco_register_checksum
строка
    Варианты:
  • включить
  • выключить
Проверка контрольной суммы всего пакета регистрации (для совместимости со старой Cisco IOS).
cisco_register_checksum_group
строка
Контрольная сумма Cisco регистрации только этих групп. Список доступа маршрутизатора источника.
join_prune_holdtime
целое число
Время удержания присоединения/обрезки (1–65535).
message_interval
целое число
Период времени между отправкой периодических сообщений присоединения/обрезки PIM в секундах (1–65535).
null_register_retries
целое число
Максимальное количество попыток нулевой регистрации (1–20).
register_rate_limit
целое число
Предел пакетов/сек на источник, зарегистрированный через этот RP (0–65535).
register_rp_reachability
строка
    Варианты:
  • включить
  • выключить
Включение/выключение проверки доступности RP перед регистрацией пакетов.
register_source
строка
    Варианты:
  • отключить
  • интерфейс
  • IP-адрес
Переопределение адреса источника в пакетах регистрации.
register_source_interface
строка
Переопределение с адресом основного интерфейса. Имя интерфейса системы источника.
register_source_ip
строка
Переопределение локального IP-адреса.
register_supression
целое число
Период времени для выполнения сообщения register-stop (1–65535 сек).
rp_address
список / элементы=строка
Статическая настройка адресов RP.
group
строка
Группы для использования этого RP. Список доступа маршрутизатора источника.
id
целое число / требуется
Идентификатор.
ip_address
строка
Адрес маршрутизатора RP.
rp_register_keepalive
целое число
Таймаут для получения данных RP на дереве (S,G) (1–65535 сек).
spt_threshold
строка
    Варианты:
  • включить
  • выключить
Включение/выключение переключения на деревья, специфичные для источника.
spt_threshold_group
строка
Группы, которым разрешено переключаться на дерево источника. Список доступа маршрутизатора источника.
ssm
строка
    Варианты:
  • включить
  • выключить
Включение/выключение мультикаста, специфичного для источника.
ssm_range
строка
Группы, которым разрешено использовать мультикаст, специфичный для источника. Список доступа маршрутизатора источника.
route_limit
целое число
Максимальное количество мультикастовых маршрутов.
route_threshold
целое число
Генерация предупреждений, когда количество мультикастовых маршрутов превышает это число, не должно быть больше route-limit.
vdom
строка
По умолчанию:
"root"
Виртуальная область, среди тех, которые определены ранее. ВД — виртуальный экземпляр FortiGate, который можно настроить и использовать как разное устройство.

Примечания

Примечание

  • Устаревший модуль fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure router multicast.
    fortios_router_multicast:
      vdom:  "{{ vdom }}"
      router_multicast:
        interface:
         -
            bfd: "enable"
            cisco_exclude_genid: "enable"
            dr_priority: "6"
            hello_holdtime: "7"
            hello_interval: "8"
            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: "12"
                last_member_query_interval: "13"
                query_interval: "14"
                query_max_response_time: "15"
                query_timeout: "16"
                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: "26"
            rp_candidate: "enable"
            rp_candidate_group: "<your_own_value> (source router.access-list.name)"
            rp_candidate_interval: "29"
            rp_candidate_priority: "30"
            state_refresh_interval: "31"
            static_group: "<your_own_value> (source router.multicast-flow.name)"
            ttl_threshold: "33"
        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: "40"
            bsr_interface: "<your_own_value> (source system.interface.name)"
            bsr_priority: "42"
            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: "47"
            message_interval: "48"
            null_register_retries: "49"
            register_rate_limit: "50"
            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: "55"
            rp_address:
             -
                group: "<your_own_value> (source router.access-list.name)"
                id:  "58"
                ip_address: "<your_own_value>"
            rp_register_keepalive: "60"
            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: "65"
        route_threshold: "66"

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

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

Ключ Возвращается Описание
build
строка
всегда
Номер сборки образа fortigate

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

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

Пример:
200
mkey
строка
успех
Главный ключ (id), используемый в последнем вызове FortiGate

Пример:
id
name
строка
всегда
Имя таблицы, использованной для выполнения запроса

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

Пример:
webfilter
revision
строка
всегда
Внутренний номер ревизии

Пример:
17.0.2.10658
serial
строка
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
status
строка
всегда
Указание результата операции

Пример:
успех
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_router_multicast_module.html

Spec-Zone.ru

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