kowabunga.cloud.adapter module – Manage Kowabunga network adapters

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

Synopsis

  • Create, update or delete a Kowabunga network adapter.

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

endpoint

string / required

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

mac

string

MAC address for the adapter (auto-generated if not specified).

name

string / required

Name for the network adapter.

This attribute cannot be updated.

reserved

boolean

Whether the adapter is reserved.

Choices:

  • false ← (default)

  • true

state

string

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

subnet

string / required

Name (or ID) of the subnet where the adapter will be created.

Examples

- name: Create a network adapter
  kowabunga.cloud.adapter:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: adapter-01
    subnet: subnet-01

- name: Delete a network adapter
  kowabunga.cloud.adapter:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: adapter-01
    subnet: subnet-01
    state: absent

Return Values

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

Key

Description

adapter

dictionary

Dictionary describing the network adapter.

Returned: On success when state is present.

addresses

list / elements=string

List of assigned IP addresses

Returned: success

Sample: ["192.168.1.10"]

description

string

Adapter description

Returned: success

Sample: "Network adapter 01"

id

string

Adapter ID

Returned: success

Sample: "6850281677f2462b6919dbe5"

mac

string

MAC address

Returned: success

Sample: "02:00:00:00:00:01"

name

string

Adapter name

Returned: success

Sample: "adapter-01"

reserved

boolean

Whether the adapter is reserved

Returned: success

Sample: false

Authors

  • The Kowabunga Project