kowabunga.cloud.instance module – Manage Kowabunga virtual machine instances

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.instance.

Synopsis

• Create, update or delete a Kowabunga virtual machine instance.

Requirements

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

• python >= 3.8

• kowabunga >= 0.52.5

Parameters

Parameter	Comments
adapters list / elements=string	List of network adapter names (or IDs) to attach to the instance.
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 instance.
endpoint string / required	HTTPS(S) URI of the Kowabunga Kahuna endpoint. Should be formatted as https://kowabunga.acme.com for example.
memory integer / required	Memory in megabytes. This attribute cannot be updated.
name string / required	Name for the instance. This attribute cannot be updated.
project string / required	Name (or ID) of the project where the instance will be created.
state string	Should the resource be present or absent. Choices: "present" ← (default) "absent"
vcpus integer / required	Number of virtual CPUs. This attribute cannot be updated.
volumes list / elements=string	List of storage volume names (or IDs) to attach to the instance.
zone string / required	Name (or ID) of the availability zone where the instance will be created.

Examples

- name: Create an instance
  kowabunga.cloud.instance:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: vm-01
    memory: 2048
    vcpus: 2
    project: my-project
    zone: eu-west-1a

- name: Delete an instance
  kowabunga.cloud.instance:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: vm-01
    project: my-project
    zone: eu-west-1a
    state: absent

Return Values

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

Key	Description
instance dictionary	Dictionary describing the instance. Returned: On success when state is present.
adapters list / elements=string	List of attached adapter IDs Returned: success Sample: ["6850281677f2462b6919dbe6"]
description string	Instance description Returned: success Sample: "VM 01"
id string	Instance ID Returned: success Sample: "6850281677f2462b6919dbe5"
memory integer	Memory in MB Returned: success Sample: 2048
name string	Instance name Returned: success Sample: "vm-01"
vcpus integer	Number of virtual CPUs Returned: success Sample: 2
volumes list / elements=string	List of attached volume IDs Returned: success Sample: ["6850281677f2462b6919dbe7"]

Authors

• The Kowabunga Project

Collection links

• Repository (Sources)