fortios_router_multicast – Настройка маршрутизатора multicast в Fortinet FortiOS и FortiGate
Новая версия 2.8.
Описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять параметры маршрутизатора и категорию multicast. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.5
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| host строка | IP-адрес FortiOS или FortiGate. | ||||
| https булево |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | |||
| password строка | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | |||
| router_multicast словарь | Значение по умолчанию: null | Настройка маршрутизации мультикаста. | |||
| interface список | Интерфейсы PIM. | ||||
| bfd строка |
| Включить/выключить обнаружение двунаправленной передачи (BFD) протокола независимой многоадресной рассылки (PIM). | |||
| cisco_exclude_genid строка |
| Исключить GenID из пакетов hello (совместимость со старой Cisco IOS). | |||
| dr_priority целое число | Приоритет выбора DR. | ||||
| hello_holdtime целое число | Время до истечения срока действия информации о старом соседе (0 - 65535 сек). | ||||
| hello_interval целое число | Интервал между отправкой сообщений hello PIM (0 - 65535 сек). | ||||
| igmp словарь | Параметры конфигурации IGMP. | ||||
| access_group строка | Группы, которым разрешено присоединяться к IGMP-хостам. Имя списка доступа маршрутизатора-источника. | ||||
| immediate_leave_group строка | Группы, членство в которых нужно немедленно снять после получения сообщения IGMPv2 о выходе. Имя списка доступа маршрутизатора-источника. | ||||
| last_member_query_count целое число | Количество запросов о группе до удаления группы (2 - 7). | ||||
| last_member_query_interval целое число | Время ожидания между IGMPv2 leave и удалением группы (1 - 65535 мс). | ||||
| query_interval целое число | Интервал между запросами IGMP-хостам (1 - 65535 сек). | ||||
| query_max_response_time целое число | Максимальное время ожидания ответа на запрос IGMP (1 - 25 сек). | ||||
| query_timeout целое число | Время ожидания между запросами до того, как маршрутизатор станет запрошивающим для сети (60 - 900). | ||||
| router_alert_check строка |
| Включить/выключить требование о том, чтобы пакеты IGMP содержали опцию маршрутизатора alert. | |||
| version строка |
| Максимальная поддерживаемая версия 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 целое число | Интервал между отправкой пакетов state-refresh (1 - 100 сек). | ||||
| static_group строка | Статически заданные группы мультикаста для передачи данных. Имя потока мультикаста маршрутизатора-источника. | ||||
| ttl_threshold целое число | Минимальное значение TTL пакетов мультикаста, которые будут передаваться (применяется только к новым маршрутам мультикаста) (1 - 255). | ||||
| multicast_routing строка |
| Включить/выключить маршрутизацию IP мультикаста. | |||
| pim_sm_global словарь | Глобальные настройки PIM в разреженном режиме. | ||||
| accept_register_list строка | Источники, разрешённые для регистрации пакетов в этой точке сбора (RP). Список доступа маршрутизатора источника. | ||||
| accept_source_list строка | Источники, разрешённые для отправки мультимедийного трафика. Список доступа маршрутизатора источника. | ||||
| bsr_allow_quick_refresh строка |
| Включить/выключить приём пакетов быстрой перезагрузки BSR от соседей. | |||
| bsr_candidate строка |
| Включить/выключить возможность этому маршрутизатору стать маршрутизатором начальной загрузки (BSR). | |||
| 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 строка |
| Переопределение адреса источника в пакетах регистрации. | |||
| 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. | ||||
| ssl_verify логический добавлен в 2.9 |
| Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации. | |||
| username строка | Имя пользователя FortiOS или FortiGate. | ||||
| vdom строка | По умолчанию: "root" | Виртуальный домен, среди ранее определённых. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. | |||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Выполнять как local_action в вашем плейбуке
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure router multicast.
fortios_router_multicast:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
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 строка | всегда | Указание результата операции Пример: success |
| vdom строка | всегда | Используемый виртуальный домен Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_router_multicast_module.html