Note
This plugin is part of the hetzner.hcloud collection (version 1.6.0).
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.
To use it in a playbook, specify: hetzner.hcloud.hcloud_certificate_info.
The below requirements are needed on the host that executes this module.
| 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
Complete reference for the Hetzner Cloud API.
- name: Gather hcloud certificate infos
hcloud_certificate_info:
register: output
- name: Print the gathered infos
debug:
var: output.hcloud_certificate_info
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) | |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/hcloud_certificate_info_module.html