ExIncus.
Copy Markdown
Manage networks (bridges, OVN networks, ...).
{:ok, networks} = ExIncus.Networks.list(client)
{:ok, _} =
ExIncus.Networks.create(client, %{
"name" => "testbr0",
"config" => %{
"ipv4.address" => "10.140.100.1/24",
"ipv4.nat" => "true",
"ipv6.address" => "none"
}
})
{:ok, leases} = ExIncus.Networks.leases(client, "testbr0")Summary
Functions
Creates a network from a NetworksPost params map (needs "name").
Deletes a network.
Fetches a single network.
Lists the DHCP leases of a network.
Lists networks (full objects by default).
Partially updates the network configuration (PATCH).
Renames a network.
Fetches the runtime state of a network (addresses, counters, ...).
Replaces the network configuration (PUT).
Types
@type result() :: {:ok, term()} | {:error, ExIncus.Error.t()}
Functions
@spec create(ExIncus.Client.t(), map(), keyword()) :: result()
Creates a network from a NetworksPost params map (needs "name").
@spec delete(ExIncus.Client.t(), String.t(), keyword()) :: result()
Deletes a network.
@spec get(ExIncus.Client.t(), String.t(), keyword()) :: result()
Fetches a single network.
@spec leases(ExIncus.Client.t(), String.t(), keyword()) :: result()
Lists the DHCP leases of a network.
@spec list( ExIncus.Client.t(), keyword() ) :: result()
Lists networks (full objects by default).
@spec patch(ExIncus.Client.t(), String.t(), map(), keyword()) :: result()
Partially updates the network configuration (PATCH).
@spec rename(ExIncus.Client.t(), String.t(), String.t(), keyword()) :: result()
Renames a network.
@spec state(ExIncus.Client.t(), String.t(), keyword()) :: result()
Fetches the runtime state of a network (addresses, counters, ...).
@spec update(ExIncus.Client.t(), String.t(), map(), keyword()) :: result()
Replaces the network configuration (PUT).