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

Note

This plugin is part of the hetzner.hcloud collection (version 1.6.0).

To install it use: ansible-galaxy collection install hetzner.hcloud.

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 Choices/Defaults Comments
api_token
string / required
This is the API Token for the Hetzner Cloud.
endpoint
string
Default:
"https://api.hetzner.cloud/v1"
This is the API Endpoint for the Hetzner Cloud.
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 Returned Description
hcloud_certificate_info
complex
Always
The certificate instances

 
certificate
string
always
Certificate and chain in PEM format

Sample:
-----BEGIN CERTIFICATE-----...
 
domain_names
dictionary
always
List of Domains and Subdomains covered by the Certificate

 
fingerprint
string
always
Fingerprint of the certificate

Sample:
03:c7:55:9b:2a:d1:04:17:09:f6:d0:7f:18:34:63:d4:3e:5f
 
id
integer
always
Numeric identifier of the certificate

Sample:
1937415
 
labels
dictionary
always
User-defined labels (key-value pairs)

 
name
string
always
Name of the certificate

Sample:
my website cert
 
not_valid_after
string
always
Point in time when the Certificate stops being valid (in ISO-8601 format)

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



Authors

  • Lukas Kaemmerling (@LKaemmerling)