hetzner.hcloud.image_info module – Gather infos about your Hetzner Cloud images.

Note

This module is part of the hetzner.hcloud collection (version 2.5.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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Gather infos about your Hetzner Cloud images.

Aliases: hcloud_image_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.

architecture

string

The architecture for the images you want to get.

Choices:

  • "x86"

  • "arm"

id

integer

The ID of the image you want to get.

The module will fail if the provided ID is invalid.

label_selector

string

The label selector for the images you want to get.

name

string

The name of the image you want to get.

type

string

The type for the images you want to get.

Choices:

  • "system" ← (default)

  • "snapshot"

  • "backup"

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Gather hcloud image infos
  hetzner.hcloud.image_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output

Return Values

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

Key

Description

hcloud_image_info

complex

The image infos as list

Returned: always

architecture

string

Image is compatible with this architecture

Returned: always

Sample: "x86"

description

string

Detail description of the image

Returned: always

Sample: "Ubuntu 18.04 Standard 64 bit"

id

integer

Numeric identifier of the image

Returned: always

Sample: 1937415

labels

dictionary

User-defined labels (key-value pairs)

Returned: always

name

string

Name of the image

Returned: always

Sample: "ubuntu-22.04"

os_flavor

string

OS flavor of the image

Returned: always

Sample: "ubuntu"

os_version

string

OS version of the image

Returned: always

Sample: "18.04"

status

string

Status of the image

Returned: always

Sample: "available"

type

string

Type of the image

Returned: always

Sample: "system"

Authors

  • Lukas Kaemmerling (@LKaemmerling)