модуль fortinet.fortios.fortios_icap_server_group — настройка группы серверов ICAP, состоящей из нескольких серверов пересылки. Поддерживает отказоустойчивость и балансировку нагрузки в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
icap_server_group словарь	Настройка группы серверов ICAP, состоящей из нескольких серверов пересылки. Поддерживает отказоустойчивость и балансировку нагрузки.
ldb_method строка	Метод балансировки нагрузки. Варианты: `"weighted"` `"least-session"` `"active-passive"`
name строка / обязательный	Настройка группы серверов ICAP, состоящей из одного или нескольких серверов пересылки. Поддерживает отказоустойчивость и балансировку нагрузки.
server_list список / элементы=словарь	Добавление серверов ICAP в список для формирования группы серверов. При необходимости можно назначить каждому серверу вес.
name строка / обязательный	Имя сервера ICAP. Источник: icap.server.name.
weight целое число	При необходимости назначение веса серверу пересылки для балансировки нагрузки с учетом весов (1–100).
member_path строка	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов больше одного, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операций с элементами.
member_state строка	Добавление или удаление элемента по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure an ICAP server group consisting of multiple forward servers. Supports failover and load balancing.
  fortinet.fortios.fortios_icap_server_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      icap_server_group:
          ldb_method: "weighted"
          name: "default_name_4"
          server_list:
              -
                  name: "default_name_6 (source icap.server.name)"
                  weight: "10"

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

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

Ключ	Описание
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_icap_server_group_module.html