hetzner.hcloud.iso_info module – Gather infos about the Hetzner Cloud ISO list.

Note

This module is part of the hetzner.hcloud collection (version 2.4.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.iso_info.

Synopsis

  • Gather infos about the Hetzner Cloud ISO list.

Aliases: hcloud_iso_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

Filter ISOs with compatible architecture.

Choices:

  • "x86"

  • "arm"

id

integer

The ID of the ISO image you want to get.

The module will fail if the provided ID is invalid.

include_architecture_wildcard

boolean

Include ISOs with wildcard architecture (architecture is null).

Works only if architecture filter is specified.

Choices:

  • false

  • true

name

string

The name of the ISO you want to get.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Gather hcloud ISO type infos
  hetzner.hcloud.iso_info:
  register: output

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

Return Values

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

Key

Description

hcloud_iso_info

complex

The ISO type infos as list

Returned: always

architecture

string

Type of cpu architecture this ISO is compatible with. None indicates no restriction on the architecture (wildcard).

Returned: when supported

Sample: "x86"

deprecated

string

ISO 8601 timestamp of deprecation, None if ISO is still available. After the deprecation time it will no longer be possible to attach the ISO to servers. This field is deprecated. Use `deprecation` instead.

Returned: always

Sample: "2024-12-01T00:00:00+00:00"

deprecation

dictionary

Describes if, when & how the resources was deprecated. If this field is set to None the resource is not deprecated. If it has a value, it is considered deprecated.

Returned: if the resource is deprecated

announced

string

Date of when the deprecation was announced.

Returned: always

Sample: "2021-11-01T00:00:00+00:00"

unavailable_after

string

After the time in this field, the resource will not be available from the general listing endpoint of the resource type, and it can not be used in new resources. For example, if this is an image, you can not create new servers with this image after the mentioned date.

Returned: always

Sample: "2021-12-01T00:00:00+00:00"

description

string

Description of the ISO

Returned: always

Sample: "Debian 12.0 (amd64/netinstall)"

id

integer

ID of the ISO

Returned: always

Sample: 22110

name

string

Unique identifier of the ISO. Only set for public ISOs

Returned: always

Sample: "debian-12.0.0-amd64-netinst.iso"

type

string

Type of the ISO, can be one of `public`, `private`.

Returned: always

Sample: "public"

Authors

  • Patrice Le Guyader (@patlegu)

  • Lukas Kaemmerling (@LKaemmerling)