Модуль fortinet.fortios.fortios_vpn_certificate_local — Локальные ключи и сертификаты в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

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

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

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

Описание

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию vpn_certificate и категорию local. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с 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"`
state строка / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальная область, среди тех, которые были определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`
vpn_certificate_local словарь	Локальные ключи и сертификаты.
acme_ca_url строка	URL-адрес сервера ACME CA (например, Let”s Encrypt).
acme_domain строка	Действительный домен, который разрешается на этом устройстве FortiGate.
acme_email строка	Адрес электронной почты, который требуется некоторыми CA, такими как LetsEncrypt.
acme_renew_window целое число	Начало периода продления (в днях до истечения срока действия сертификата, по умолчанию 30).
acme_rsa_key_size целое число	Длина RSA-ключа генерируемого сертификата (минимум 2048 бит).
auto_regenerate_days целое число	Количество дней ожидания перед запросом обновления локального сертификата (0 = отключено).
auto_regenerate_days_warning целое число	Количество дней ожидания перед отображением предупреждения об истечении срока действия (0 = отключено).
ca_identifier строка	Идентификатор CA сервера для подписи через SCEP.
certificate строка	Сертификат в формате PEM.
cmp_path строка	Путь на сервере CMP.
cmp_regeneration_method строка	Метод автоматического восстановления CMP. Варианты: `"keyupate"` `"renewal"`
cmp_server строка	Адрес и порт сервера CMP (формат = адрес:порт).
cmp_server_cert строка	Сертификат сервера CMP. Источник vpn.certificate.ca.name vpn.certificate.remote.name.
comments строка	Комментарий.
csr строка	Запрос на подписание сертификата (CSR).

END_OF_DOCUMENT_MARKER

enroll_protocol string	Протокол регистрации сертификата. Варианты: `"none"` `"scep"` `"cmpv2"` `"acme2"` `"est"`
est_ca_id string	Идентификатор ЦС сервера ЦС для подписи через EST.
est_client_cert string	Сертификат, используемый для аутентификации этого FortiGate на сервере EST. Источник vpn.certificate.local.name.
est_http_password string	Пароль аутентификации HTTP для подписи через EST.
est_http_username string	Имя пользователя аутентификации HTTP для подписи через EST.
est_server string	Адрес и порт сервера EST (например, https://example.com:1234).
est_server_cert string	Сертификат сервера EST должен быть проверяем этим сертификатом для аутентификации. Источник vpn.certificate.ca.name vpn.certificate.remote.name.
est_srp_password string	Пароль аутентификации EST SRP.
est_srp_username string	Имя пользователя аутентификации EST SRP.
ike_localid string	Локальный идентификатор, который FortiGate использует для аутентификации в качестве клиента VPN.
ike_localid_type string	Тип локального идентификатора IKE. Варианты: `"asn1dn"` `"fqdn"`
last_updated integer	Время последнего обновления сертификата.
name string / обязательно	Имя.
name_encoding string	Метод кодирования имени для автоматической регенерации. Варианты: `"printable"` `"utf8"`
password string	Пароль в формате PEM.
private_key string	Ключ в формате PEM, зашифрованный паролем.
private_key_retain string	Включить/выключить сохранение закрытого ключа при обновлении SCEP. Варианты: `"enable"` `"disable"`
range string	Диапазон IP-адресов глобальный или VDOM для сертификата. Варианты: `"global"` `"vdom"`
scep_password string	Пароль для проверки SCEP сервера для авто-регенерации.
scep_url string	URL сервера SCEP.
source string	Тип источника сертификата. Варианты: `"factory"` `"user"` `"bundle"`
source_ip string	IP-адрес источника для связи с сервером SCEP.
state string	Состояние запроса на подпись сертификата.

Примечания

Примечание

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

Примеры

- name: Local keys and certificates.
  fortinet.fortios.fortios_vpn_certificate_local:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_certificate_local:
          acme_ca_url: "<your_own_value>"
          acme_domain: "<your_own_value>"
          acme_email: "<your_own_value>"
          acme_renew_window: "30"
          acme_rsa_key_size: "2048"
          auto_regenerate_days: "0"
          auto_regenerate_days_warning: "0"
          ca_identifier: "myId_10"
          certificate: "<your_own_value>"
          cmp_path: "<your_own_value>"
          cmp_regeneration_method: "keyupate"
          cmp_server: "<your_own_value>"
          cmp_server_cert: "<your_own_value> (source vpn.certificate.ca.name vpn.certificate.remote.name)"
          comments: "<your_own_value>"
          csr: "<your_own_value>"
          enroll_protocol: "none"
          est_ca_id: "<your_own_value>"
          est_client_cert: "<your_own_value> (source vpn.certificate.local.name)"
          est_http_password: "<your_own_value>"
          est_http_username: "<your_own_value>"
          est_server: "<your_own_value>"
          est_server_cert: "<your_own_value> (source vpn.certificate.ca.name vpn.certificate.remote.name)"
          est_srp_password: "<your_own_value>"
          est_srp_username: "<your_own_value>"
          ike_localid: "<your_own_value>"
          ike_localid_type: "asn1dn"
          last_updated: "2147483647"
          name: "default_name_30"
          name_encoding: "printable"
          password: "<your_own_value>"
          private_key: "<your_own_value>"
          private_key_retain: "enable"
          range: "global"
          scep_password: "<your_own_value>"
          scep_url: "<your_own_value>"
          source: "factory"
          source_ip: "84.230.14.43"
          state: "<your_own_value>"

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

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

Ключ	Описание
build string	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при последней применённой операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), использованный в последнем вызове 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_vpn_certificate_local_module.html