Модуль fortinet.fortios.fortios_certificate_hsm_local — локальные сертификаты, ключи которых хранятся на HSM в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_certificate_hsm_local.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции certificate и категории hsm_local. В примерах приведены все параметры; перед использованием необходимо изменить значения с учётом источников данных. Проверено на FOS v6.0.0
Требования
На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate. |
certificate_hsm_local dictionary | Локальные сертификаты, ключи которых хранятся на HSM. |
|
api_version string |
Версия API для взаимодействия с HSM. Варианты:
|
|
certificate string |
Сертификат в формате PEM. |
|
comments string |
Комментарий. |
|
gch_cloud_service_name string |
Имя конфигурации облачной службы для создания токена доступа. Источник: system.cloud-service.name. |
|
gch_cryptokey string |
Криптографический ключ Google Cloud HSM. |
|
gch_cryptokey_algorithm string |
Алгоритм криптографического ключа Google Cloud HSM. Варианты:
|
|
gch_cryptokey_version string |
Версия криптографического ключа Google Cloud HSM. |
|
gch_keyring string |
Связка ключей Google Cloud HSM. |
|
gch_location string |
Расположение Google Cloud HSM. |
|
gch_project string |
Идентификатор проекта Google Cloud HSM. |
|
name string / обязательный |
Имя. |
|
range string |
Глобальный диапазон IP-адресов или диапазон IP-адресов VDOM для сертификата. Варианты:
|
|
source string |
Тип источника сертификата. Варианты:
|
|
vendor string |
Производитель HSM. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанным member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Поддержка устаревшего fortiosapi прекращена; для запуска плейбуков рекомендуется использовать httpapi
Примеры
- name: Local certificates whose keys are stored on HSM.
fortinet.fortios.fortios_certificate_hsm_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
certificate_hsm_local:
api_version: "unknown"
certificate: "<your_own_value>"
comments: "<your_own_value>"
gch_cloud_service_name: "<your_own_value> (source system.cloud-service.name)"
gch_cryptokey: "<your_own_value>"
gch_cryptokey_algorithm: "rsa-sign-pkcs1-2048-sha256"
gch_cryptokey_version: "<your_own_value>"
gch_keyring: "<your_own_value>"
gch_location: "<your_own_value>"
gch_project: "<your_own_value>"
name: "default_name_13"
range: "global"
source: "factory"
vendor: "unknown"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_certificate_hsm_local_module.html