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

Примечание

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

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

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

Для использования в playbook, укажите: fortinet.fortios.fortios_system_acme.

Новый в fortinet.fortios 2.0.0

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

Описание

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

Требования

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

ansible>=2.15

Параметры

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

Примечания

Примечание

Модуль fortiosapi устарел, httpapi предпочтительный способ выполнения playbooks

Примеры

- name: Configure ACME client.
  fortinet.fortios.fortios_system_acme:
      vdom: "{{ vdom }}"
      system_acme:
          accounts:
              -
                  ca_url: "<your_own_value>"
                  email: "<your_own_value>"
                  id: "6"
                  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 строка	Номер сборки образа 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_acme_module.html