Модуль fortinet.fortios.fortios_router_multicast_flow — настройка multicast-flow в 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_flow.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции маршрутизатора в категории multicast_flow. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Описание |
|---|---|
access_token string | Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path предназначен для выполнения операций с элементами. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
router_multicast_flow dictionary | Настройка multicast-flow. |
|
comments string |
Комментарий. |
|
flows list / элементы типа dictionary |
Записи multicast-flow. |
|
group_addr string |
IP-адрес группы multicast. |
|
id integer / обязательный |
Идентификатор потока. См. <a href=’#notes’>Примечания</a>. |
|
source_addr string |
IP-адрес источника multicast. |
|
name string / обязательный |
Имя. |
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure multicast-flow.
fortinet.fortios.fortios_router_multicast_flow:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_multicast_flow:
comments: "<your_own_value>"
flows:
-
group_addr: "<your_own_value>"
id: "6"
source_addr: "<your_own_value>"
name: "default_name_8"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (id), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_flow_module.html