модуль fortinet.fortios.fortios_vpn_certificate_local – Локальные ключи и сертификаты в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанным member_path допускает выполнение операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, нужно ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
vpn_certificate_local dictionary | Локальные ключи и сертификаты. |
|
acme_ca_url string |
URL сервера центра сертификации ACME (Let’s Encrypt — это ). |
|
acme_domain string |
Действительное доменное имя, разрешающееся в адрес этого устройства FortiGate. |
|
acme_eab_key_hmac string |
Ключ HMAC привязки внешней учетной записи (закодированный в Base64 с URL-кодированием). |
|
acme_eab_key_id string |
Идентификатор ключа привязки внешней учетной записи (необязательный параметр). |
|
acme_email string |
Контактный адрес электронной почты, требуемый некоторыми центрами сертификации, например Let’s Encrypt. |
|
acme_renew_window integer |
Начало периода продления (за сколько дней до истечения срока действия сертификата; по умолчанию — 30). |
|
acme_rsa_key_size integer |
Длина закрытого ключа RSA создаваемого сертификата (не менее 2048 бит). |
|
auto_regenerate_days integer |
За сколько дней до истечения срока действия запрашивать обновление локального сертификата (0 = отключено). |
|
auto_regenerate_days_warning integer |
За сколько дней до истечения срока действия создавать предупреждение (0 = отключено). |
|
ca_identifier string |
Идентификатор центра сертификации на сервере CA для подписания через SCEP. |
|
certificate string |
Сертификат в формате PEM. |
|
cmp_path string |
Путь к расположению на сервере CMP. |
|
cmp_regeneration_method string |
Метод автоматического перевыпуска CMP. Варианты:
|
|
cmp_server string |
Адрес и порт сервера CMP (формат = адрес:порт). |
|
cmp_server_cert string |
Сертификат сервера CMP. Источник: vpn.certificate.ca.name, vpn.certificate.remote.name. |
|
comments string |
Комментарий. |
|
csr string |
Запрос на подпись сертификата. |
|
enroll_protocol string |
Протокол регистрации сертификата. Варианты:
|
|
est_ca_id string |
Идентификатор центра сертификации на сервере CA для подписания через EST. |
|
est_client_cert string |
Сертификат, используемый для аутентификации этого устройства FortiGate на сервере EST. Источник: vpn.certificate.local.name. |
|
est_http_password string |
Пароль HTTP-аутентификации для подписания через EST. |
|
est_http_username string |
Имя пользователя для HTTP-аутентификации при подписании через EST. |
|
est_regeneration_method string |
Параметры поведения 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 |
Пароль аутентификации SRP для EST. |
|
est_srp_username string |
Имя пользователя для аутентификации SRP в EST. |
|
ike_localid string |
Локальный идентификатор, используемый FortiGate для аутентификации в качестве VPN-клиента. |
|
ike_localid_type string |
Тип локального идентификатора IKE. Варианты:
|
|
last_updated integer |
Время последнего обновления сертификата. |
|
name string / обязательный |
Имя. |
|
name_encoding string |
Метод кодирования имени для автоматического перевыпуска. Варианты:
|
|
password string |
Пароль в виде файла PEM. |
|
private_key string |
Ключ в формате PEM, зашифрованный паролем. |
|
private_key_retain string |
Включить или отключить сохранение закрытого ключа при продлении SCEP. Варианты:
|
|
range string |
Глобальный диапазон IP-адресов или диапазон IP-адресов VDOM для сертификата. Варианты:
|
|
scep_password string |
Пароль-запрос сервера SCEP для автоматического перевыпуска. |
|
scep_url string |
URL сервера SCEP. |
|
source string |
Тип источника сертификата. Варианты:
|
|
source_ip string |
Исходный IP-адрес для обмена данными с сервером SCEP. |
|
state string |
Состояние запроса на подпись сертификата. |
Примечания
Примечание
- Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi.
- Модуль поддерживает 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_eab_key_hmac: "<your_own_value>"
acme_eab_key_id: "<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_12"
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_regeneration_method: "create-new-key"
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_33"
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 Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_vpn_certificate_local_module.html