kowabunga.cloud.kiwi module – Manage Kowabunga inner WAN interface nodes

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

Synopsis

  • Create, update or delete a Kowabunga Kiwi inner WAN interface node.

Requirements

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

  • python >= 3.8

  • kowabunga >= 0.52.5

Parameters

Parameter

Comments

agents

list / elements=string

List of agent names (or IDs) managing this kiwi node.

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 kiwi node.

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 kiwi node.

This attribute cannot be updated.

region

string / required

Name (or ID) of the region where the kiwi will be created.

state

string

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

Examples

- name: Create a kiwi node
  kowabunga.cloud.kiwi:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: kiwi-01
    agents:
      - my-agent
    region: eu-west-1

- name: Delete a kiwi node
  kowabunga.cloud.kiwi:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: kiwi-01
    region: eu-west-1
    state: absent

Return Values

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

Key

Description

kiwi

dictionary

Dictionary describing the kiwi node.

Returned: On success when state is present.

agents

list / elements=string

List of agent IDs

Returned: success

Sample: ["6850281677f2462b6919dbe6"]

description

string

Kiwi description

Returned: success

Sample: "Kiwi node 01"

id

string

Kiwi ID

Returned: success

Sample: "6850281677f2462b6919dbe5"

name

string

Kiwi name

Returned: success

Sample: "kiwi-01"

Authors

  • The Kowabunga Project