hetzner.hcloud.hcloud_certificate_info module – Gather infos about your Hetzner Cloud certificates.

Note

This module is part of the hetzner.hcloud collection (version 1.8.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install hetzner.hcloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hetzner.hcloud.hcloud_certificate_info.

Synopsis

  • Gather facts about your Hetzner Cloud certificates.

Requirements

The below requirements are needed on the host that executes this module.

  • hcloud-python >= 1.0.0

Parameters

Parameter

Comments

api_token

string / required

This is the API Token for the Hetzner Cloud.

endpoint

string

This is the API Endpoint for the Hetzner Cloud.

Default: "https://api.hetzner.cloud/v1"

id

integer

The ID of the certificate you want to get.

label_selector

string

The label selector for the certificate you want to get.

name

string

The name of the certificate you want to get.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Gather hcloud certificate infos
  hcloud_certificate_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_certificate_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

hcloud_certificate_info

complex

The certificate instances

Returned: Always

certificate

string

Certificate and chain in PEM format

Returned: always

Sample: "-----BEGIN CERTIFICATE-----..."

domain_names

dictionary

List of Domains and Subdomains covered by the Certificate

Returned: always

fingerprint

string

Fingerprint of the certificate

Returned: always

Sample: "03:c7:55:9b:2a:d1:04:17:09:f6:d0:7f:18:34:63:d4:3e:5f"

id

integer

Numeric identifier of the certificate

Returned: always

Sample: 1937415

labels

dictionary

User-defined labels (key-value pairs)

Returned: always

name

string

Name of the certificate

Returned: always

Sample: "my website cert"

not_valid_after

string

Point in time when the Certificate stops being valid (in ISO-8601 format)

Returned: always

not_valid_before

string

Point in time when the Certificate becomes valid (in ISO-8601 format)

Returned: always

Authors

  • Lukas Kaemmerling (@LKaemmerling)