Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_certificate_local — Локальные ключи и сертификаты в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

Возможно, эта коллекция уже установлена, если вы используете пакет 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), позволяя пользователю задавать и изменять параметры сертификата и локальной категории. Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием в источниках данных. Тестировалось с FOS v6.0.0

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токена. Сгенерирован из интерфейса Fortigate.

certificate_local

словарь

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

acme_ca_url

строка

URL сервера ACME CA (например, Let”s Encrypt).

acme_domain

строка

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

acme_email

строка

Адрес электронной почты, необходимый некоторыми CA, например, Let’s Encrypt.

acme_renew_window

целое число

Начало периода продления (в днях до истечения срока действия сертификата, по умолчанию 30).

acme_rsa_key_size

целое число

Длина RSA закрытого ключа генерируемого сертификата (минимум 2048 бит).

auto_regenerate_days

целое число

Количество дней ожидания перед запросом обновления локального сертификата (0 = выключено).

auto_regenerate_days_warning

целое число

Количество дней ожидания перед генерацией предупреждения об истечении срока действия (0 = выключено).

ca_identifier

строка

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

certificate

строка

Сертификат в формате PEM.

cmp_path

строка

Путь на сервере CMP.

cmp_regeneration_method

строка

Метод автоматического обновления CMP.

Варианты:

  • "keyupate"
  • "renewal"

cmp_server

строка

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

cmp_server_cert

строка

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

comments

строка

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

csr

строка

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

enroll_protocol

строка

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

Варианты:

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

est_ca_id

строка

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

est_client_cert

строка

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

est_http_password

строка

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

est_http_username

строка

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

est_server

строка

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

est_server_cert

строка

Сертификат сервера EST должен быть проверим этим сертификатом для аутентификации. Источник certificate.ca.name certificate.remote.name.

est_srp_password

string

Пароль аутентификации EST SRP.

est_srp_username

string

Имя пользователя аутентификации EST SRP.

ike_localid

string

Локальный ID, используемый FortiGate для аутентификации в качестве VPN-клиента.

ike_localid_type

string

Тип локального ID IKE.

Варианты:

  • "asn1dn"
  • "fqdn"

last_updated

integer

Время последнего обновления сертификата.

name

string / required

Имя.

name_encoding

string

Метод кодирования имени для автоматического повторного создания.

Варианты:

  • "printable"
  • "utf8"

password

string

Пароль в формате PEM-файла.

private_key

string

Ключ в формате PEM, зашифрованный паролем.

private_key_retain

string

Включить/отключить сохранение закрытого ключа во время обновления SCEP.

Варианты:

  • "enable"
  • "disable"

range

string

Диапазон 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 ← (default)
  • true

member_path

string

Путь к атрибуту члена для выполнения операции.

Разделяется символом слэша, если атрибутов несколько.

Параметр, помеченный как member_path, является допустимым для выполнения операции с членом.

member_state

string

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

При указании member_state параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / required

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

Варианты:

  • "present"
  • "absent"

vdom

string

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

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

Примечания

Примечание

  • Устаревший fortiosapi был снят с поддержки, httpapi является предпочтительным способом запуска playbooks
  • Модуль поддерживает 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_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_10"
          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_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_30"
          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

строка

Номер сборки образа fortigate

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

Пример: "1547"

http_method

строка

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

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

Пример: "PUT"

http_status

строка

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

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

Пример: "200"

mkey

строка

Главный ключ (id), используемый в последнем вызове FortiGate

Возвращается: успешно

Пример: "id"

name

строка

Имя таблицы, используемой для выполнения запроса

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

строка

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

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

Пример: "success"

vdom

строка

Используемый виртуальный домен

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

Пример: "root"

version

строка

Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_certificate_local_module.html

Spec-Zone.ru

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