kowabunga.cloud.vnet module – Manage Kowabunga virtual networks

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

Synopsis

  • Create, update or delete a Kowabunga virtual network.

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 virtual network.

endpoint

string / required

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

interface

string / required

Physical interface name to use for this virtual network.

This attribute cannot be updated.

name

string / required

Name for the virtual network.

This attribute cannot be updated.

private

boolean

Whether the virtual network is private.

Choices:

  • false

  • true ← (default)

region

string / required

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

state

string

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

vlan

integer

VLAN ID for the virtual network.

Examples

- name: Create a virtual network
  kowabunga.cloud.vnet:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: vnet-01
    interface: eth0
    region: eu-west-1

- name: Delete a virtual network
  kowabunga.cloud.vnet:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: vnet-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

vnet

dictionary

Dictionary describing the virtual network.

Returned: On success when state is present.

description

string

VNet description

Returned: success

Sample: "Virtual network 01"

id

string

VNet ID

Returned: success

Sample: "6850281677f2462b6919dbe5"

interface

string

Physical interface name

Returned: success

Sample: "eth0"

name

string

VNet name

Returned: success

Sample: "vnet-01"

private

boolean

Whether the network is private

Returned: success

Sample: true

vlan

integer

VLAN ID

Returned: success

Sample: 100

Authors

  • The Kowabunga Project