Spec-Zone.ru › Ansible 2.8

fortios_router_multicast – Настройка маршрутизатора multicast в Fortinet’s FortiOS и FortiGate

Новая в версии 2.8.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

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

Требования

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

  • 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 сек, по умолчанию = 105).
hello-interval
-
Интервал между отправкой сообщений hello PIM (0—65535 сек, по умолчанию = 30).
igmp
-
Настройки IGMP.
access-group
-
Группы хостов IGMP, которым разрешено присоединяться. Имя списка доступа маршрутизатора источника.
immediate-leave-group
-
Группы, членство в которых должно быть удалено сразу после получения сообщения IGMPv2 об уходе. Имя списка доступа маршрутизатора источника.
last-member-query-count
-
Количество запросов, относящихся к группе, перед удалением группы (2—7, по умолчанию = 2).
last-member-query-interval
-
Время ожидания между оставлением группы IGMPv2 и удалением группы (1—65535 мс, по умолчанию = 1000).
query-interval
-
Интервал между запросами к хостам IGMP (1—65535 сек, по умолчанию = 125).
query-max-response-time
-
Максимальное время ожидания ответа на запрос IGMP (1—25 сек, по умолчанию = 10).
query-timeout
-
Время ожидания между запросами перед переходом в режим запроса сети (60—900, по умолчанию = 255).
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
-
    Варианты:
  • режим sparse
  • режим dense
Режим работы PIM.
propagation-delay
-
Задержка распространения пакетов по этому интерфейсу (100—5000 мс, по умолчанию = 500).
rp-candidate
-
    Варианты:
  • включить
  • выключить
Включить/выключить участие в выборах RP.
rp-candidate-group
-
Группы мультикаста, управляемые этим RP. Имя списка доступа маршрутизатора источника.
rp-candidate-interval
-
Интервал объявления кандидата на роль RP (1—16383 сек, по умолчанию = 60).
rp-candidate-priority
-
Приоритет маршрутизатора как RP.
state-refresh-interval
-
Интервал между отправкой пакетов state-refresh (1—100 сек, по умолчанию = 60).
static-group
-
Статически настроенные группы мультикаста для переадресации. Имя потока мультикаста маршрутизатора источника.
ttl-threshold
-
Минимальное значение TTL пакетов мультикаста, которые будут переадресованы (применяется только к новым маршрутам мультикаста) (1—255, по умолчанию = 1).
multicast-routing
-
    Варианты:
  • включить
  • выключить
Включить/выключить маршрутизацию IP-мультикаста.
pim-sm-global
-
Глобальные настройки PIM в режиме sparse-mode.
accept-register-list
-
Источники, разрешенные для регистрации пакетов в этой точке Rendezvous (RP). Список доступа маршрутизатора-источника.
accept-source-list
-
Источники, разрешенные для отправки мультимедийного трафика. Список доступа маршрутизатора-источника.
bsr-allow-quick-refresh
-
    Варианты:
  • enable
  • disable
Включить/выключить прием пакетов быстрого обновления BSR от соседей.
bsr-candidate
-
    Варианты:
  • enable
  • disable
Включить/выключить возможность этому маршрутизатору стать маршрутизатором-распределителем (BSR).
bsr-hash
-
Длина хэша BSR (0-32, по умолчанию = 10).
bsr-interface
-
Интерфейс для объявления кандидатом в BSR. Имя интерфейса источника.
bsr-priority
-
Приоритет BSR (0-255, по умолчанию = 0).
cisco-crp-prefix
-
    Варианты:
  • enable
  • disable
Включить/выключить совместимость кандидата RP со старой Cisco IOS.
cisco-ignore-rp-set-priority
-
    Варианты:
  • enable
  • disable
Использовать только хэш для выбора RP (совместимость со старой Cisco IOS).
cisco-register-checksum
-
    Варианты:
  • enable
  • disable
Проверка контрольной суммы всего пакета регистрации (для совместимости со старой Cisco IOS).
cisco-register-checksum-group
-
Контрольная сумма Cisco для этих групп. Список доступа маршрутизатора-источника.
join-prune-holdtime
-
Время удержания join/prune (1-65535, по умолчанию = 210).
message-interval
-
Период времени между отправкой периодических сообщений PIM join/prune в секундах (1-65535, по умолчанию = 60).
null-register-retries
-
Максимальное количество попыток нулевой регистрации (1-20, по умолчанию = 1).
register-rate-limit
-
Предел пакетов/сек на источник, зарегистрированный через эту RP (0-65535, по умолчанию = 0, что означает без ограничений).
register-rp-reachability
-
    Варианты:
  • enable
  • disable
Включить/выключить проверку доступности RP перед регистрацией пакетов.
register-source
-
    Варианты:
  • disable
  • interface
  • ip-address
Переопределить адрес источника в пакетах регистрации.
register-source-interface
-
Переопределить с адресом основного интерфейса. Имя интерфейса источника.
register-source-ip
-
Переопределить с локальным IP-адресом.
register-supression
-
Период времени для соблюдения сообщения register-stop (1-65535 сек, по умолчанию = 60).
rp-address
-
Статически настроить адреса RP.
group
-
Группы для использования этой RP. Список доступа маршрутизатора-источника.
id
- / обязательно
Идентификатор.
ip-address
-
Адрес маршрутизатора RP.
rp-register-keepalive
-
Тайм-аут для RP, принимающего данные по дереву (S,G) (1-65535 сек, по умолчанию = 185).
spt-threshold
-
    Варианты:
  • enable
  • disable
Включить/выключить переключение на деревья, специфичные для источника.
spt-threshold-group
-
Группы, разрешенные для переключения на дерево источника. Список доступа маршрутизатора-источника.
ssm
-
    Варианты:
  • enable
  • disable
Включить/выключить мультимедиа, специфичные для источника.
ssm-range
-
Группы, разрешенные для мультимедиа, специфичные для источника. Список доступа маршрутизатора-источника.
route-limit
-
Максимальное количество мультимедийных маршрутов.
route-threshold
-
Выдать предупреждения, когда количество мультимедийных маршрутов превысит это значение, не должно быть больше, чем route-limit.
username
- / обязательно
Имя пользователя FortiOS или FortiGate.
vdom
-
По умолчанию:
"root"
Виртуальная область (VDOM), среди определённых ранее. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

Примечания

Примечание

  • Требуется библиотека fortiosapi, разработанная Fortinet
  • Выполняется как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  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.8/modules/fortios_router_multicast_module.html

Spec-Zone.ru

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