модуль fortinet.fortios.fortios_firewall_vipgrp – Настройка групп виртуальных IPv4-адресов в FortiOS и FortiGate от Fortinet.

Примечание

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

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

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

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

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_vipgrp словарь	Настройка групп виртуальных IPv4-адресов.
color целое число	Целое число, определяющее цвет значка в графическом интерфейсе (от 1 до 32).
comments строка	Комментарий.
interface строка	Интерфейс. Источник: system.interface.name.
member список / элементы=словарь	Объекты VIP, входящие в группу (несколько объектов разделяются пробелом).
name строка / обязательный	Имя VIP. Источник: firewall.vip.name.
name строка / обязательный	Имя группы VIP.
uuid строка	Универсальный уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную).
member_path строка	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанным member_path можно использовать для выполнения операции с элементом.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure IPv4 virtual IP groups.
  fortinet.fortios.fortios_firewall_vipgrp:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_vipgrp:
          color: "0"
          comments: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          member:
              -
                  name: "default_name_7 (source firewall.vip.name)"
          name: "default_name_8"
          uuid: "<your_own_value>"

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

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат операции Возвращается: всегда Пример: `"success"`
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–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_vipgrp_module.html