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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install hetzner.hcloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

Для использования в playbook, укажите: hetzner.hcloud.certificate.

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

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

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

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

Требования

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

python-dateutil >= 2.7.5
requests >=2.20

Параметры

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

См. также

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

Примеры

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

Авторы

Lukas Kaemmerling (@lkaemmerling)

Ссылки на сборку

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