модуль fortinet.fortios.fortios_vpn_certificate_setting — настройка сертификатов VPN в 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_setting.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции и категории vpn_certificate. В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных. Проверено на 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 игнорируется. Варианты:
|
vdom string | Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство. По умолчанию: |
vpn_certificate_setting dictionary | Настройка сертификатов VPN. |
|
cert_expire_warning integer |
За сколько дней до истечения срока действия сертификата отправлять предупреждение. Укажите 0, чтобы отключить отправку предупреждений (0–100). |
|
certname_dsa1024 string |
Сертификат с ключом DSA длиной 1024 бита для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_dsa2048 string |
Сертификат с ключом DSA длиной 2048 бит для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_ecdsa256 string |
Сертификат с ключом ECDSA длиной 256 бит для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_ecdsa384 string |
Сертификат с ключом ECDSA длиной 384 бита для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_ecdsa521 string |
Сертификат с ключом ECDSA длиной 521 бит для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_ed25519 string |
Сертификат с ключом EdDSA длиной 253 бита для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_ed448 string |
Сертификат с ключом EdDSA длиной 456 бит для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_rsa1024 string |
Сертификат с ключом RSA длиной 1024 бита для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_rsa2048 string |
Сертификат с ключом RSA длиной 2048 бит для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
certname_rsa4096 string |
Сертификат с ключом RSA длиной 4096 бит для повторной подписи серверных сертификатов при проверке SSL. Источник: vpn.certificate.local.name. |
|
check_ca_cert string |
Включить или отключить проверку сертификата пользователя и проходить аутентификацию, если доверенным является любой центр сертификации в цепочке. Варианты:
|
|
check_ca_chain string |
Включить или отключить проверку всей цепочки сертификатов и проходить аутентификацию, только если цепочка полная и все центры сертификации в ней являются доверенными. Варианты:
|
|
cmp_key_usage_checking string |
Включить или отключить проверку назначения ключа серверного сертификата в режиме CMP. Варианты:
|
|
cmp_save_extra_certs string |
Включить или отключить сохранение дополнительных сертификатов в режиме CMP. Варианты:
|
|
cn_allow_multi string |
При поиске подходящего сертификата разрешить несколько полей CN в имени субъекта сертификата. Варианты:
|
|
cn_match string |
При поиске подходящего сертификата задать способ сопоставления значения CN с именем субъекта сертификата. Варианты:
|
|
crl_verification dictionary |
Параметры проверки CRL. |
|
chain_crl_absence string |
Параметр проверки CRL на случай отсутствия CRL для какого-либо сертификата в цепочке. Варианты:
|
|
expiry string |
Параметр проверки CRL на случай истечения срока действия CRL. Варианты:
|
|
leaf_crl_absence string |
Параметр проверки CRL на случай отсутствия CRL конечного сертификата. Варианты:
|
|
interface string |
Укажите исходящий интерфейс для связи с сервером. Источник: system.interface.name. |
|
interface_select_method string |
Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты:
|
|
ocsp_default_server string |
Сервер OCSP по умолчанию. Источник: vpn.certificate.ocsp-server.name. |
|
ocsp_option string |
Укажите, следует ли использовать URL OCSP из сертификата или настроенного сервера OCSP. Варианты:
|
|
ocsp_status string |
Включить или отключить получение сертификатов с помощью OCSP. Варианты:
|
|
proxy string |
Полное доменное имя или IP-адрес прокси-сервера для запросов OCSP/CA при проверке сертификата. |
|
proxy_password string |
Пароль прокси-сервера. |
|
proxy_port integer |
Порт прокси-сервера (1–65535). |
|
proxy_username string |
Имя пользователя прокси-сервера. |
|
source_ip string |
Исходный IP-адрес для динамических запросов AIA и OCSP. |
|
ssl_min_proto_version string |
Минимальная поддерживаемая версия протокола для соединений SSL/TLS. Варианты:
|
|
ssl_ocsp_option string |
Укажите, следует ли использовать URL OCSP из сертификата или сервера OCSP по умолчанию. Варианты:
|
|
ssl_ocsp_source_ip string |
Исходный IP-адрес для связи с сервером OCSP. |
|
ssl_ocsp_status string |
Включить или отключить OCSP для SSL. Варианты:
|
|
strict_crl_check string |
Включить или отключить строгую проверку CRL. Варианты:
|
|
strict_ocsp_check string |
Включить или отключить строгую проверку OCSP. Варианты:
|
|
subject_match string |
При поиске подходящего сертификата задать способ сопоставления значения RDN с именем субъекта сертификата. Варианты:
|
|
subject_set string |
При поиске подходящего сертификата задать способ сопоставления набора RDN с именем субъекта сертификата. Варианты:
|
|
vrf_select integer |
Идентификатор VRF, используемый для подключения к серверу. |
Примечания
Примечание
- Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: VPN certificate setting.
fortinet.fortios.fortios_vpn_certificate_setting:
vdom: "{{ vdom }}"
vpn_certificate_setting:
cert_expire_warning: "14"
certname_dsa1024: "<your_own_value> (source vpn.certificate.local.name)"
certname_dsa2048: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa256: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa384: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa521: "<your_own_value> (source vpn.certificate.local.name)"
certname_ed25519: "<your_own_value> (source vpn.certificate.local.name)"
certname_ed448: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa1024: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa2048: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa4096: "<your_own_value> (source vpn.certificate.local.name)"
check_ca_cert: "enable"
check_ca_chain: "enable"
cmp_key_usage_checking: "enable"
cmp_save_extra_certs: "enable"
cn_allow_multi: "disable"
cn_match: "substring"
crl_verification:
chain_crl_absence: "ignore"
expiry: "ignore"
leaf_crl_absence: "ignore"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ocsp_default_server: "<your_own_value> (source vpn.certificate.ocsp-server.name)"
ocsp_option: "certificate"
ocsp_status: "enable"
proxy: "<your_own_value>"
proxy_password: "<your_own_value>"
proxy_port: "8080"
proxy_username: "<your_own_value>"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
ssl_ocsp_option: "certificate"
ssl_ocsp_source_ip: "<your_own_value>"
ssl_ocsp_status: "enable"
strict_crl_check: "enable"
strict_ocsp_check: "enable"
subject_match: "substring"
subject_set: "subset"
vrf_select: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_setting_module.html