Модуль hetzner.hcloud.certificate — создание и управление сертификатами в Hetzner Cloud.

Примечание

Этот модуль входит в коллекцию hetzner.hcloud (версия 6.9.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install hetzner.hcloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: hetzner.hcloud.certificate.

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

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

Создание, обновление и управление сертификатами в Hetzner Cloud.

Псевдонимы: hcloud_certificate

Требования

Следующие требования должны быть выполнены на узле, где выполняется этот модуль.

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint string	Конечная точка API Hetzner Cloud. Этот параметр также можно задать с помощью переменной окружения `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner string	Конечная точка API Hetzner. Этот параметр также можно задать с помощью переменной окружения `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token string / обязательный	Токен для API Hetzner Cloud. Этот параметр также можно задать с помощью переменной окружения `HCLOUD_TOKEN`.
certificate string	Сертификат и цепочка в формате PEM, упорядоченные так, чтобы каждая запись удостоверяла непосредственно предшествующую ей. Обязательный параметр, если сертификат не существует и type=uploaded.
domain_names list / элементы=string	Домены и поддомены, которые должны быть указаны в сертификате, выданном Let’s Encrypt. Обязательный параметр, если type=managed. По умолчанию: `[]`
id integer	ID сертификата Hetzner Cloud, которым нужно управлять. Обязателен, только если имя сертификата name не указано.
labels dictionary	Пользовательские метки (пары ключ-значение)
name string	Имя сертификата Hetzner Cloud, которым нужно управлять. Обязателен, только если ID сертификата id не указан или сертификат не существует.
private_key string	Ключ сертификата в формате PEM. Обязательный параметр, если сертификат не существует и type=uploaded.
state string	Состояние сертификата. Допустимые значения: `"absent"` `"present"` ← (по умолчанию)
type string	Выберите между загрузкой сертификата в формате PEM и запросом управляемого сертификата Let’s Encrypt. Допустимые значения: `"uploaded"` ← (по умолчанию) `"managed"`

См. также

Документация по API Hetzner: Полный справочник по API Hetzner.

Примеры

- name: Create a basic certificate
  hetzner.hcloud.certificate:
    name: my-certificate
    certificate: -----BEGIN CERTIFICATE-----...
    private_key: -----BEGIN PRIVATE KEY-----...
    state: present

- name: Create a certificate with labels
  hetzner.hcloud.certificate:
    name: my-certificate
    certificate: -----BEGIN CERTIFICATE-----...
    private_key: -----BEGIN PRIVATE KEY-----...
    labels:
      key: value
      mylabel: 123
    state: present

- name: Create a managed certificate
  hetzner.hcloud.certificate:
    name: my-certificate
    type: managed
    domain_names:
      - example.com
      - www.example.com
    state: present

- name: Ensure the certificate is absent (remove if needed)
  hetzner.hcloud.certificate:
    name: my-certificate
    state: absent

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

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

Ключ	Описание
hcloud_certificate dictionary	Экземпляр сертификата Возвращается: всегда
certificate string	Сертификат и цепочка в формате PEM Возвращается: всегда Пример: `"-----BEGIN CERTIFICATE-----..."`
domain_names dictionary	Список доменов и поддоменов, охватываемых сертификатом Возвращается: всегда
fingerprint string	Отпечаток сертификата Возвращается: всегда Пример: `"03:c7:55:9b:2a:d1:04:17:09:f6:d0:7f:18:34:63:d4:3e:5f"`
id integer	Числовой идентификатор сертификата Возвращается: всегда Пример: `1937415`
labels dictionary	Пользовательские метки (пары ключ-значение) Возвращается: всегда
name string	Имя сертификата Возвращается: всегда Пример: `"my website cert"`
not_valid_after string	Момент времени, когда срок действия сертификата истекает (в формате ISO-8601) Возвращается: всегда
not_valid_before string	Момент времени, с которого сертификат становится действительным (в формате ISO-8601) Возвращается: всегда

Авторы

Lukas Kaemmerling (@lkaemmerling)

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

© 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/hetzner/hcloud/certificate_module.html