kowabunga.cloud.template module – Manage Kowabunga VM templates

Note

This module is part of the kowabunga.cloud collection (version 0.1.0).

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 kowabunga.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: kowabunga.cloud.template.

Synopsis

  • Create, update or delete a Kowabunga VM template.

Requirements

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

  • python >= 3.8

  • kowabunga >= 0.52.5

Parameters

Parameter

Comments

api_key

string / required

Private API key used to connect with specified Kowabunga Kahuna endpoint. Recommended to be encrypted using Ansible Vault or SOPS.

description

string

Description for the template.

endpoint

string / required

HTTPS(S) URI of the Kowabunga Kahuna endpoint. Should be formatted as https://kowabunga.acme.com for example.

name

string / required

Name for the template.

This attribute cannot be updated.

os

string

Operating system type for the template.

Choices:

  • "linux" ← (default)

  • "windows"

pool

string / required

Name (or ID) of the storage pool where the template will be stored.

source

string / required

URL or path to the template source image.

This attribute cannot be updated.

state

string

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

Examples

- name: Create a VM template
  kowabunga.cloud.template:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: ubuntu-24.04
    source: https://cloud-images.ubuntu.com/noble/current/noble-server-cloudimg-amd64.img
    pool: pool-01

- name: Delete a VM template
  kowabunga.cloud.template:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: ubuntu-24.04
    pool: pool-01
    state: absent

Return Values

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

Key

Description

template

dictionary

Dictionary describing the template.

Returned: On success when state is present.

description

string

Template description

Returned: success

Sample: "Ubuntu 24.04 LTS"

id

string

Template ID

Returned: success

Sample: "6850281677f2462b6919dbe5"

name

string

Template name

Returned: success

Sample: "ubuntu-24.04"

os

string

Operating system type

Returned: success

Sample: "linux"

source

string

Template source URL/path

Returned: success

Sample: "https://cloud-images.ubuntu.com/noble/current/noble-server-cloudimg-amd64.img"

Authors

  • The Kowabunga Project