Network.LXD.Client

This module exposes functionality to create LXD clients. These can be used to communciate to an LXD daemon, either using the high-level Network.LXD.Client.Commands module, or the low-level Network.LXD.Client.API module.

You are probably looking for Network.LXD.Client.Commands, which exposes a high-level interface to communicate with the LXD daemon.

If you are simply connecting to the LXD daemon on your local host, you shouldn't import this module. The Network.LXD.Client.Commands module probably re-exports enough functionality for your needs.

Documentation

module Network.LXD.Client.Types

LXD Host Management

HTTPS Clients

Types

data RemoteHost

A structure containing everything to connect to a remote LXD host.

Constructors

RemoteHost

Fields

• remoteHostHost :: Host

  The remote host to use when querying the HTTP endpoint. (default=127.0.0.1)

• remoteHostPort :: Int

  The remote port to use when querying the HTTP endpoint. (default=8443)

• remoteHostBasePath :: String

  The base path to use when querying the HTTP endpoint. (default=/)

• remoteHostClientKey :: ClientAuth

  The client authentication to use when connecting.

• remoteHostCertificate :: ServerAuth

  The server certificate to trust.

Instances

Default RemoteHost

Methods

def :: RemoteHost

data ClientAuth

Specifies the client authentication method.

Constructors

NoClientAuth

Do not authenticate the client.

DefaultClientAuth

Look in ~.configlxc and fetch the client certificate.

ClientAuthKey PrivateKey

Use a custom private key.

data ServerAuth

Specifies the server authentication method.

Constructors

DefaultCAStore

Use the default CA store when checking the certificate.

DefaultServerAuth RemoteName

Look in ~.configlxc/servercerts and fetch the server certificate for the specified remote.

ServerAuth Certificate

Use a custom server certificate.

type Host = String

type RemoteName = String

type Certificate = FilePath

type Key = FilePath

data PrivateKey

Constructors

PrivateKey Certificate Key

Functions

remoteHostClient :: (MonadError String m, MonadIO m) => RemoteHost -> m ClientEnv

remoteHostManager :: (MonadError String m, MonadIO m) => RemoteHost -> m Manager

clientManager :: (MonadError String m, MonadIO m) => Host -> Maybe PrivateKey -> Maybe Certificate -> m Manager

Unix Clients

newtype LocalHost

A structure containing everything to connect to a lcoal LXD host.

Constructors

LocalHost

Fields

• localHostUnix :: FilePath

  The path to the local unix socket.

Instances

Default LocalHost

Methods

def :: LocalHost

localHostClient :: MonadIO m => LocalHost -> m ClientEnv

WebSockets Clients

runWebSocketsRemote :: (MonadError String m, MonadIO m) => RemoteHost -> String -> ClientApp a -> m a

runWebSocketsLocal :: (MonadError String m, MonadIO m) => LocalHost -> String -> ClientApp a -> m a