Модуль fortinet.fortios.fortios_icap_server — настройка серверов 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.

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
icap_server dictionary	Настройка серверов ICAP.
addr_type string	Тип адреса удалённого сервера ICAP: IPv4, IPv6 или FQDN. Варианты: `"ip4"` `"ip6"` `"fqdn"`
fqdn string	Полное доменное имя (FQDN) удалённого сервера ICAP.
healthcheck string	Включить или отключить проверку работоспособности удалённого сервера ICAP. Выполняются попытки подключения к удалённому серверу ICAP, чтобы проверить, работает ли он нормально. Варианты: `"disable"` `"enable"`
healthcheck_service string	Имя службы ICAP, используемой для проверки работоспособности.
ip6_address string	Адрес IPv6 сервера ICAP.
ip_address string	Адрес IPv4 сервера ICAP.
ip_version string	Версия IP. Варианты: `"4"` `"6"`
max_connections integer	Максимальное количество одновременных подключений к серверу ICAP (0 означает отсутствие ограничений). Значение не должно быть меньше wad-worker-count.
name string / обязательный	Имя сервера.
port integer	Порт сервера ICAP.
secure string	Включить или отключить защищённое подключение к серверу ICAP. Варианты: `"disable"` `"enable"`
ssl_cert string	Имя сертификата CA. Источник: certificate.ca.name.
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 ICAP servers.
  fortinet.fortios.fortios_icap_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      icap_server:
          addr_type: "ip4"
          fqdn: "<your_own_value>"
          healthcheck: "disable"
          healthcheck_service: "<your_own_value>"
          ip_address: "<your_own_value>"
          ip_version: "4"
          ip6_address: "<your_own_value>"
          max_connections: "100"
          name: "default_name_11"
          port: "1344"
          secure: "disable"
          ssl_cert: "<your_own_value> (source certificate.ca.name)"

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

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

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