ExIncus.Server (ex_incus v1.0.0)

Copy Markdown

Server-level information and configuration (the /1.0 endpoint).

{:ok, info} = ExIncus.Server.info(client)
info["environment"]["server_version"]

Summary

Functions

Fetches server information: API version, auth status, environment, config.

Partially updates the server configuration (PATCH).

Fetches hardware resource information (CPU, memory, disks, network cards).

Replaces the server configuration (PUT with %{"config" => %{...}}).

Types

result()

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

Functions

info(client, opts \\ [])

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

Fetches server information: API version, auth status, environment, config.

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

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

Partially updates the server configuration (PATCH).

resources(client, opts \\ [])

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

Fetches hardware resource information (CPU, memory, disks, network cards).

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

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

Replaces the server configuration (PUT with %{"config" => %{...}}).