/ home / ansible / ansible.builtin / v2.8.17 / module / hcloud_image_facts

ansible.builtin.hcloud_image_facts (v2.8.17) — module

Gather facts about your Hetzner Cloud images.

| "added in version" 2.8 of ansible.builtin"

Authors: Lukas Kaemmerling (@lkaemmerling)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.8.17

Description

Gather facts about your Hetzner Cloud images.

Requirements

hcloud-python >= 1.20.0

Usage examples

Scanned by Steampunk Spotter

- name: Gather hcloud image facts
  local_action:
    module: hcloud_image_facts

Scanned by Steampunk Spotter

- name: Print the gathered facts
  debug:
    var: ansible_facts.hcloud_image_facts

Inputs

    
id:
    description:
    - The ID of the image you want to get.
    type: int

name:
    description:
    - The name of the image you want to get.
    type: str

type:
    choices:
    - system
    - snapshot
    - backup
    default: system
    description:
    - The label selector for the images you want to get.

endpoint:
    default: https://api.hetzner.cloud/v1
    description:
    - This is the API Endpoint for the Hetzner Cloud.
    type: str

api_token:
    description:
    - This is the API Token for the Hetzner Cloud.
    - You can also set this option by using the environment variable HCLOUD_TOKEN
    required: true
    type: str

label_selector:
    description:
    - The label selector for the images you want to get.
    type: str

Outputs

hcloud_image_facts:
  contains:
    description:
      description: Detail description of the image
      returned: always
      sample: Ubuntu 18.04 Standard 64 bit
      type: str
    id:
      description: Numeric identifier of the image
      returned: always
      sample: 1937415
      type: int
    labels:
      description: User-defined labels (key-value pairs)
      returned: always
      type: dict
    name:
      description: Name of the image
      returned: always
      sample: ubuntu-18.04
      type: str
    os_flavor:
      description: OS flavor of the image
      returned: always
      sample: ubuntu
      type: str
    os_version:
      description: OS version of the image
      returned: always
      sample: 18.04
      type: str
    status:
      description: Status of the image
      returned: always
      sample: available
      type: str
    type:
      description: Type of the image
      returned: always
      sample: system
      type: str
  description: The image facts as list
  returned: always
  type: complex

Install Ansible via pip