You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Note

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

Synopsis

• Gather infos about your Hetzner Cloud images.

• This module was called hcloud_location_facts before Ansible 2.9, returning ansible_facts and hcloud_location_facts. Note that the hetzner.hcloud.hcloud_image_info module no longer returns ansible_facts and the value was renamed to hcloud_image_info!

Requirements

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

• hcloud-python >= 1.0.0

Parameters

Parameter	Comments
api_token string / required	This is the API Token for the Hetzner Cloud. You can also set this option by using the environment variable HCLOUD_TOKEN
endpoint string	This is the API Endpoint for the Hetzner Cloud. Default: "https://api.hetzner.cloud/v1"
id integer	The ID of the image you want to get.
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 label selector 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
  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
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-18.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)

Collection links

Issue Tracker Repository (Sources)