ExIncus.StoragePools (ex_incus v1.0.0)

Manage storage pools. For volumes inside a pool see ExIncus.StorageVolumes.

Summary

Types

result()

Functions

create(client, params, opts \\ [])

Creates a storage pool from a StoragePoolsPost params map, e.g. %{"name" => "fast", "driver" => "zfs", "config" => %{...}}.

delete(client, name, opts \\ [])

Deletes a storage pool.

get(client, name, opts \\ [])

Fetches a single storage pool.

list(client, opts \\ [])

Lists storage pools (full objects by default).

patch(client, name, params, opts \\ [])

Partially updates the pool configuration (PATCH).

resources(client, name, opts \\ [])

Fetches usage information for a pool.

update(client, name, params, opts \\ [])

Replaces the pool configuration (PUT).

Types

result()

@type result() :: {:ok, term()} | {:error, ExIncus.Error.t()}

Functions

create(client, params, opts \\ [])

@spec create(ExIncus.Client.t(), map(), keyword()) :: result()

Creates a storage pool from a StoragePoolsPost params map, e.g. %{"name" => "fast", "driver" => "zfs", "config" => %{...}}.

delete(client, name, opts \\ [])

@spec delete(ExIncus.Client.t(), String.t(), keyword()) :: result()

Deletes a storage pool.

get(client, name, opts \\ [])

@spec get(ExIncus.Client.t(), String.t(), keyword()) :: result()

Fetches a single storage pool.

list(client, opts \\ [])

@spec list(
  ExIncus.Client.t(),
  keyword()
) :: result()

Lists storage pools (full objects by default).

patch(client, name, params, opts \\ [])

@spec patch(ExIncus.Client.t(), String.t(), map(), keyword()) :: result()

Partially updates the pool configuration (PATCH).

resources(client, name, opts \\ [])

@spec resources(ExIncus.Client.t(), String.t(), keyword()) :: result()

Fetches usage information for a pool.

update(client, name, params, opts \\ [])

@spec update(ExIncus.Client.t(), String.t(), map(), keyword()) :: result()

Replaces the pool configuration (PUT).