Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_firewall_multicast_address — настройка адресов многоадресной рассылки в Fortinet FortiOS и FortiGate.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_firewall_multicast_address.

Добавлено в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

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

enable_log

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

firewall_multicast_address

dictionary

Настройка адресов многоадресной рассылки.

associated_interface

string

Интерфейс, связанный с объектом адреса. При настройке политики доступны только адреса, связанные с этим интерфейсом. Источник: system.interface.name.

color

integer

Целочисленное значение, определяющее цвет значка в графическом интерфейсе (1–32).

comment

string

Комментарий.

end_ip

string

Последний адрес IPv4 (включительно) в диапазоне адресов.

name

string / обязательный

Имя адреса многоадресной рассылки.

start_ip

string

Первый адрес IPv4 (включительно) в диапазоне адресов.

subnet

string

Широковещательный адрес и подсеть.

tagging

list / elements=dictionary

Добавление тегов к объекту конфигурации.

category

string

Категория тегов. Источник: system.object-tagging.category.

name

string / обязательный

Имя записи тегирования.

tags

list / elements=dictionary

Теги.

name

string / обязательный

Имя тега. Источник: system.object-tagging.tags.name.

type

string

Тип объекта адреса: диапазон IP-адресов многоадресной рассылки или широковещательный IP-адрес/маска, обрабатываемые как адрес многоадресной рассылки.

Варианты:

  • "multicastrange"
  • "broadcastmask"

visibility

string

Включение или отключение отображения адреса многоадресной рассылки в графическом интерфейсе.

Варианты:

  • "enable"
  • "disable"

member_path

string

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

Если атрибутов несколько, они разделяются косой чертой.

Параметр с пометкой member_path можно использовать для выполнения операции с элементом.

member_state

string

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

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

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Определяет, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

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

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

Примечания

Примечание

  • Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure multicast addresses.
  fortinet.fortios.fortios_firewall_multicast_address:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_multicast_address:
          associated_interface: "<your_own_value> (source system.interface.name)"
          color: "0"
          comment: "Comment."
          end_ip: "<your_own_value>"
          name: "default_name_7"
          start_ip: "<your_own_value>"
          subnet: "<your_own_value>"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_12"
                  tags:
                      -
                          name: "default_name_14 (source system.object-tagging.tags.name)"
          type: "multicastrange"
          visibility: "enable"

Возвращаемые значения

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

Ключ

Описание

build

string

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

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

Пример: "1547"

http_method

string

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

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

Пример: "PUT"

http_status

string

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

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

Пример: "200"

mkey

string

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

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

Пример: "id"

name

string

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

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

Пример: "urlfilter"

path

string

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

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

Пример: "webfilter"

revision

string

Внутренний номер редакции

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

Пример: "17.0.2.10658"

serial

string

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

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

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

Пример: "success"

vdom

string

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

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

Пример: "root"

version

string

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

Spec-Zone.ru

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