Модуль fortinet.fortimanager.fmgr_vpn_certificate_hsmlocal — локальные сертификаты, ключи которых хранятся в HSM.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_vpn_certificate_hsmlocal.

Добавлено в fortinet.fortimanager 2.12.0

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

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

Этот модуль позволяет настраивать устройство FortiManager.
В примерах приведены все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, которыми будут переопределены условия неудачного выполнения.
rc_succeeded list / элементы=integer	Список кодов rc, которыми будут переопределены условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
vpn_certificate_hsmlocal dictionary	Набор параметров верхнего уровня.
api_version псевдонимы: api-version string	Версия API для взаимодействия с HSM. Варианты: `"unknown"` `"gch-default"`
certificate string	Сертификат в формате PEM.
comments string	Комментарий.
gch_cloud_service_name псевдонимы: gch-cloud-service-name list / элементы=string	Имя конфигурации облачной службы для создания токена доступа.
gch_cryptokey псевдонимы: gch-cryptokey string	Криптографический ключ Google Cloud HSM.
gch_cryptokey_algorithm псевдонимы: gch-cryptokey-algorithm string	Алгоритм криптографического ключа Google Cloud HSM. Варианты: `"rsa-sign-pkcs1-2048-sha256"` `"rsa-sign-pkcs1-3072-sha256"` `"rsa-sign-pkcs1-4096-sha256"` `"rsa-sign-pkcs1-4096-sha512"` `"rsa-sign-pss-2048-sha256"` `"rsa-sign-pss-3072-sha256"` `"rsa-sign-pss-4096-sha256"` `"rsa-sign-pss-4096-sha512"` `"ec-sign-p256-sha256"` `"ec-sign-p384-sha384"` `"ec-sign-secp256k1-sha256"` `"2048-RSA-PKCS1v1.5-SHA256"` `"3072-RSA-PKCS1v1.5-SHA256"` `"4096-RSA-PKCS1v1.5-SHA256"` `"4096-RSA-PKCS1v1.5-SHA512"` `"EC_P256_SHA256"` `"EC_P384_SHA384"` `"EC_secp256k1_SHA256"`
gch_cryptokey_version псевдонимы: gch-cryptokey-version string	Версия криптографического ключа Google Cloud HSM.
gch_keyring псевдонимы: gch-keyring string	Связка ключей Google Cloud HSM.
gch_location псевдонимы: gch-location string	Расположение Google Cloud HSM.
gch_project псевдонимы: gch-project string	Идентификатор проекта Google Cloud HSM.
gch_url псевдонимы: gch-url string	URL GCH.
name string / обязательный	Имя.
range string	Глобальный диапазон IP-адресов или диапазон IP-адресов VDOM для сертификата. Варианты: `"global"` `"vdom"`
source string	Тип источника сертификата. Варианты: `"factory"` `"user"` `"bundle"`
tmp_cert_file псевдонимы: tmp-cert-file string	Временный файл сертификата.
vendor string	Производитель HSM. Варианты: `"unknown"` `"gch"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие значения, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов используют соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия неудачного или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Local certificates whose keys are stored on HSM.
      fortinet.fortimanager.fmgr_vpn_certificate_hsmlocal:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        vpn_certificate_hsmlocal:
          name: "your value" # Required variable, string
          # api_version: <value in [unknown, gch-default]>
          # certificate: <string>
          # comments: <string>
          # gch_cloud_service_name: <list or string>
          # gch_cryptokey: <string>
          # gch_cryptokey_algorithm: <value in [rsa-sign-pkcs1-2048-sha256, rsa-sign-pkcs1-3072-sha256, rsa-sign-pkcs1-4096-sha256, ...]>
          # gch_cryptokey_version: <string>
          # gch_keyring: <string>
          # gch_location: <string>
          # gch_project: <string>
          # gch_url: <string>
          # range: <value in [global, vdom]>
          # source: <value in [factory, user, bundle]>
          # tmp_cert_file: <string>
          # vendor: <value in [unknown, gch]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_vpn_certificate_hsmlocal_module.html