Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_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_certificate_local.

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

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции сертификатов и категории local. Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.

certificate_local

dictionary

Локальные ключи и сертификаты.

acme_ca_url

string

URL сервера центра сертификации ACME (например, Let’s Encrypt).

acme_domain

string

Действительный домен, разрешающийся в адрес этого устройства FortiGate.

acme_eab_key_hmac

string

Ключ HMAC для привязки внешней учётной записи (URL-кодированный base64).

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.

Варианты:

  • "keyupate"
  • "renewal"

cmp_server

string

Адрес и порт сервера CMP (формат: адрес:порт).

cmp_server_cert

string

Сертификат сервера CMP. Источник: certificate.ca.name, certificate.remote.name.

comments

string

Комментарий.

csr

string

Запрос на подпись сертификата.

enroll_protocol

string

Протокол регистрации сертификата.

Варианты:

  • "none"
  • "scep"
  • "cmpv2"
  • "acme2"
  • "est"

est_ca_id

string

Идентификатор центра сертификации на сервере CA для подписания через EST.

est_client_cert

string

Сертификат, используемый для аутентификации этого устройства FortiGate на сервере EST. Источник: certificate.local.name.

est_http_password

string

Пароль для HTTP-аутентификации при подписании через EST.

est_http_username

string

Имя пользователя для HTTP-аутентификации при подписании через EST.

est_regeneration_method

string

Параметры поведения EST при повторной регистрации.

Варианты:

  • "create-new-key"
  • "use-existing-key"

est_server

string

Адрес и порт сервера EST (например, https://example.com:1234).

est_server_cert

string

Сертификат сервера EST должен быть проверяемым с помощью этого сертификата, чтобы сервер прошёл аутентификацию. Источник: certificate.ca.name, 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-адресов или диапазон 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

Состояние запроса на подпись сертификата.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым выполняется операция.

Если атрибутов несколько, они разделяются косой чертой.

Параметр с указанием member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

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

Примеры

- name: Local keys and certificates.
  fortinet.fortios.fortios_certificate_local:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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 certificate.ca.name 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 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 certificate.ca.name 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

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate при последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове 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–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_local_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API