hetzner.hcloud.ssh_key_info module – Gather infos about your Hetzner Cloud ssh_keys.

Note

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

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.ssh_key_info.

Synopsis

  • Gather facts about your Hetzner Cloud ssh_keys.

Aliases: hcloud_ssh_key_info

Requirements

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

  • python-dateutil >= 2.7.5

  • requests >=2.20

Parameters

Parameter

Comments

api_endpoint

aliases: endpoint

string

The API Endpoint for the Hetzner Cloud.

You can also set this option by using the HCLOUD_ENDPOINT environment variable.

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

api_token

string / required

The API Token for the Hetzner Cloud.

You can also set this option by using the HCLOUD_TOKEN environment variable.

fingerprint

string

The fingerprint of the ssh key you want to get.

id

integer

The ID of the ssh key you want to get.

The module will fail if the provided ID is invalid.

label_selector

string

The label selector for the ssh key you want to get.

name

string

The name of the ssh key you want to get.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Gather hcloud sshkey infos
  hetzner.hcloud.ssh_key_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_ssh_key_info

Return Values

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

Key

Description

hcloud_ssh_key_info

complex

The ssh key instances

Returned: Always

fingerprint

string

Fingerprint of the ssh key

Returned: always

Sample: "0e:e0:bd:c7:2d:1f:69:49:94:44:91:f1:19:fd:35:f3"

id

integer

Numeric identifier of the ssh_key

Returned: always

Sample: 1937415

labels

dictionary

User-defined labels (key-value pairs)

Returned: always

name

string

Name of the ssh_key

Returned: always

Sample: "my-ssh-key"

public_key

string

The actual public key

Returned: always

Sample: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGpl/tnk74nnQJxxLAtutUApUZMRJxryKh7VXkNbd4g9 john@example.com"

Authors

  • Christopher Schmitt (@cschmitt-hcloud)