модуль fortinet.fortios.fortios_system_acme — настройка клиента ACME в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

Новое в fortinet.fortios 2.0.0

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Допустимые значения: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Допустимые значения: `"present"` `"absent"`
system_acme dictionary	Настройка клиента ACME.
accounts list / элементы типа dictionary	Список учётных записей ACME.
ca_url string	URL центра сертификации учётной записи.
eab_key_hmac string	HMAC-ключ привязки внешней учётной записи.
eab_key_id string	Идентификатор ключа привязки внешней учётной записи.
email string	Адрес электронной почты учётной записи.
id string / обязательный	Идентификатор учётной записи.
privatekey string	Закрытый ключ учётной записи.
status string	Состояние учётной записи.
url string	URL учётной записи.
interface list / элементы типа dictionary	Интерфейс(ы), на которых клиент ACME будет ожидать запросы проверки.
interface_name string / обязательный	Имя интерфейса. Источник: system.interface.name.
source_ip string	Исходный адрес IPv4 для подключения к серверу ACME.
source_ip6 string	Исходный адрес IPv6 для подключения к серверу ACME.
use_ha_direct string	Разрешить использование интерфейса «ha-mgmt» для подключения к серверу ACME, если в конфигурации HA включён параметр «ha-direct» Допустимые значения: `"enable"` `"disable"`
vdom string	Виртуальный домен из числа предварительно заданных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure ACME client.
  fortinet.fortios.fortios_system_acme:
      vdom: "{{ vdom }}"
      system_acme:
          accounts:
              -
                  ca_url: "<your_own_value>"
                  eab_key_hmac: "<your_own_value>"
                  eab_key_id: "<your_own_value>"
                  email: "<your_own_value>"
                  id: "8"
                  privatekey: "<your_own_value>"
                  status: "<your_own_value>"
                  url: "myurl.com"
          interface:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          use_ha_direct: "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_system_acme_module.html