kowabunga.cloud.nfs module – Manage Kowabunga NFS storage

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

Synopsis

• Create, update or delete a Kowabunga NFS storage.

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.
backends list / elements=string	List of backend addresses.
description string	Description for the NFS storage.
endpoint string / required	HTTPS(S) URI of the Kowabunga Kahuna endpoint. Should be formatted as https://kowabunga.acme.com for example.
fs string	NFS filesystem type. Default: "nfs"
name string / required	Name for the NFS storage. This attribute cannot be updated.
port integer	NFS server port. Default: 54934
region string / required	Name (or ID) of the region where the NFS storage will be created.
server string / required	NFS server address (IP or hostname). This attribute cannot be updated.
state string	Should the resource be present or absent. Choices: "present" ← (default) "absent"

Examples

- name: Create NFS storage
  kowabunga.cloud.nfs:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: nfs-01
    server: 192.168.1.10
    region: eu-west-1

- name: Delete NFS storage
  kowabunga.cloud.nfs:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: nfs-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
nfs dictionary	Dictionary describing the NFS storage. Returned: On success when state is present.
description string	NFS storage description Returned: success Sample: "NFS storage 01"
endpoint string	NFS server address Returned: success Sample: "192.168.1.10"
fs string	Filesystem type Returned: success Sample: "nfs"
id string	NFS storage ID Returned: success Sample: "6850281677f2462b6919dbe5"
name string	NFS storage name Returned: success Sample: "nfs-01"
port integer	NFS server port Returned: success Sample: 54934

Authors

• The Kowabunga Project

Collection links

• Repository (Sources)