Network.LXD.Client.API

This module exposes a low-level Servant-built API for the LXD daemon.

You can query this API using Servant functions and a client created from Network.LXD.Client.

You probably want to use the commands exposed in Network.LXD.Client.Commands instead.

API

data FailureResponse

Exception thrown in containerGetPath, containerDeletePath and containerPostPath.

Constructors

FailureResponse Request (Response ByteString)

Instances

Show FailureResponse

Methods

showsPrec :: Int -> FailureResponse -> ShowS

show :: FailureResponse -> String

showList :: [FailureResponse] -> ShowS

Exception FailureResponse

Methods

toException :: FailureResponse -> SomeException

fromException :: SomeException -> Maybe FailureResponse

displayException :: FailureResponse -> String

Information

supportedVersions :: ClientM (Response [ApiVersion])

apiConfig :: ClientM (Response ApiConfig)

trustedCertificates :: ClientM (Response [CertificateHash])

Containers

Querying informaiton

containerNames :: ClientM (Response [ContainerName])

containerCreate :: ContainerCreateRequest -> ClientM (AsyncResponse Value)

container :: ContainerName -> ClientM (Response Container)

containerDelete :: ContainerName -> ContainerDeleteRequest -> ClientM (AsyncResponse Value)

Configuration

containerPut :: ContainerName -> ContainerPut -> ClientM (AsyncResponse Value)

containerPatch :: ContainerName -> ContainerPatch -> ClientM (Response Value)

containerRename :: ContainerName -> ContainerRename -> ClientM (AsyncResponse Value)

State

containerState :: ContainerName -> ClientM (Response ContainerState)

containerPutState :: ContainerName -> ContainerPutState -> ClientM (AsyncResponse Value)

Executing commands

containerExecImmediate :: ExecClient ExecImmediate

containerExecWebsocketInteractive :: ExecClient ExecWebsocketInteractive

containerExecWebsocketNonInteractive :: ExecClient ExecWebsocketNonInteractive

Working with files

data WriteMode

Constructors

ModeOverwrite

ModeAppend

Instances

Show WriteMode

Methods

showsPrec :: Int -> WriteMode -> ShowS

show :: WriteMode -> String

showList :: [WriteMode] -> ShowS

containerGetPath :: ContainerName -> FilePath -> ClientM PathResponse

containerPostPath :: ContainerName -> FilePath -> Maybe Uid -> Maybe Gid -> Maybe FileMode -> FileType -> Maybe WriteMode -> ByteString -> ClientM (Response Value)

containerDeletePath :: ContainerName -> FilePath -> ClientM (Response Value)

Images

imageIds :: ClientM (Response [ImageId])

imageCreate :: ImageCreateRequest -> ClientM (AsyncResponse Value)

imageAliases :: ClientM (Response [ImageAliasName])

imageAlias :: ImageAliasName -> ClientM (Response ImageAlias)

image :: ImageId -> ClientM (Response Image)

imageDelete :: ImageId -> ImageDeleteRequest -> ClientM (AsyncResponse Value)

Networks

networkList :: ClientM (Response [NetworkName])

networkCreate :: NetworkCreateRequest -> ClientM (Response Value)

network :: NetworkName -> ClientM (Response Network)

networkPut :: NetworkName -> NetworkConfigRequest -> ClientM (Response Value)

networkPatch :: NetworkName -> NetworkConfigRequest -> ClientM (Response Value)

networkDelete :: NetworkName -> ClientM (Response Value)

Profiles

profileList :: ClientM (Response [ProfileName])

profileCreate :: ProfileCreateRequest -> ClientM (Response Value)

profile :: ProfileName -> ClientM (Response Profile)

profilePut :: ProfileName -> ProfileConfigRequest -> ClientM (Response Value)

profilePatch :: ProfileName -> ProfileConfigRequest -> ClientM (Response Value)

profileDelete :: ProfileName -> ClientM (Response Value)

Storage

poolList :: ClientM (Response [PoolName])

poolCreate :: PoolCreateRequest -> ClientM (Response Value)

pool :: PoolName -> ClientM (Response Pool)

poolPut :: PoolName -> PoolConfigRequest -> ClientM (Response Value)

poolPatch :: PoolName -> PoolConfigRequest -> ClientM (Response Value)

poolDelete :: PoolName -> ClientM (Response Value)

Volumes

volumeList :: PoolName -> ClientM (Response [VolumeName])

volumeCreate :: PoolName -> VolumeCreateRequest -> ClientM (Response Value)

volume :: PoolName -> VolumeName -> ClientM (Response Volume)

volumePut :: PoolName -> VolumeName -> VolumeConfigRequest -> ClientM (Response Value)

volumePatch :: PoolName -> VolumeName -> VolumeConfigRequest -> ClientM (Response Value)

volumeDelete :: PoolName -> VolumeName -> ClientM (Response Value)

Operations

operationIds :: ClientM (Response AllOperations)

operation :: OperationId -> ClientM (Response Operation)

operationCancel :: OperationId -> ClientM (Response Value)

operationWait :: OperationId -> ClientM (Response Operation)

operationWebSocket :: OperationId -> Secret -> String

WebSocket communciations

readAllWebSocket :: (ByteString -> IO ()) -> ClientApp ()

writeAllWebSocket :: MVar (Maybe ByteString) -> ClientApp ()

Helpers

type ExecClient a = ContainerName -> ExecRequest a -> ClientM (AsyncResponse (ExecResponseMetadata a))