Network.LXD.Client.Types

This module implements all types used to communicate with the LXD daemon REST end-point.

These types are e.g. used in the Network.LXD.Client.Commands module.

Generic responses

data GenericResponse op a

Generic LXD API response object.

Constructors

Response

Fields

• responseType :: ResponseType
• status :: String
• statusCode :: StatusCode
• responseOperation :: op
• errorCode :: Int
• error :: String
• metadata :: a

Instances

(Show a, Show op) => Show (GenericResponse op a)

Methods

showsPrec :: Int -> GenericResponse op a -> ShowS

show :: GenericResponse op a -> String

showList :: [GenericResponse op a] -> ShowS

(FromJSON op, FromJSON a) => FromJSON (GenericResponse op a)

Methods

parseJSON :: Value -> Parser (GenericResponse op a)

parseJSONList :: Value -> Parser [GenericResponse op a]

type Response a = GenericResponse String a

LXD API synchronous repsonse object, without resulting operation.

type AsyncResponse a = GenericResponse OperationId (BackgroundOperation a)

LXD API asynchronous response object, with resulting operation

data ResponseType

The type of a generic response object.

Constructors

Sync

Async

Instances

Eq ResponseType

Methods

(==) :: ResponseType -> ResponseType -> Bool

(/=) :: ResponseType -> ResponseType -> Bool

Show ResponseType

Methods

showsPrec :: Int -> ResponseType -> ShowS

show :: ResponseType -> String

showList :: [ResponseType] -> ShowS

FromJSON ResponseType

Methods

parseJSON :: Value -> Parser ResponseType

parseJSONList :: Value -> Parser [ResponseType]

data StatusCode

Constructors

SCreated

SStopped

SRunning

SSuccess

SFailure

SCancelled

SOther Int

Instances

Eq StatusCode

Methods

(==) :: StatusCode -> StatusCode -> Bool

(/=) :: StatusCode -> StatusCode -> Bool

Ord StatusCode

Methods

compare :: StatusCode -> StatusCode -> Ordering

(<) :: StatusCode -> StatusCode -> Bool

(<=) :: StatusCode -> StatusCode -> Bool

(>) :: StatusCode -> StatusCode -> Bool

(>=) :: StatusCode -> StatusCode -> Bool

max :: StatusCode -> StatusCode -> StatusCode

min :: StatusCode -> StatusCode -> StatusCode

Show StatusCode

Methods

showsPrec :: Int -> StatusCode -> ShowS

show :: StatusCode -> String

showList :: [StatusCode] -> ShowS

ToJSON StatusCode

Methods

toJSON :: StatusCode -> Value

toEncoding :: StatusCode -> Encoding

toJSONList :: [StatusCode] -> Value

toEncodingList :: [StatusCode] -> Encoding

FromJSON StatusCode

Methods

parseJSON :: Value -> Parser StatusCode

parseJSONList :: Value -> Parser [StatusCode]

Background operations

data BackgroundOperation m

Background operation response object, with metadata of type m.

Constructors

BackgroundOperation

Fields

• backgroundOperationId :: String
• backgroundOperationClass :: String
• backgroundOperationCreatedAt :: String
• backgroundOperationUpdatedAt :: String
• backgroundOperationStatus :: String
• backgroundOperationStatusCode :: StatusCode
• backgroundOperationMetadata :: m
• backgroundOperationMayCancel :: Bool
• backgroundOperationeErr :: String

Instances

FromJSON m => FromJSON (BackgroundOperation m)

Methods

parseJSON :: Value -> Parser (BackgroundOperation m)

parseJSONList :: Value -> Parser [BackgroundOperation m]

API

data ApiConfig

LXD API configuration object.

Returend when querying GET /1.0. Some objects may not be present if an untrusted requeset was made.

Constructors

ApiConfig

Fields

• apiExtensions :: [ApiExtension]
• apiStatus :: ApiStatus
• apiVersion :: String
• authStatus :: AuthStatus
• serverConfig :: Maybe Value
• serverEnv :: Maybe Value
• serverPublic :: Bool

Instances

Show ApiConfig

Methods

showsPrec :: Int -> ApiConfig -> ShowS

show :: ApiConfig -> String

showList :: [ApiConfig] -> ShowS

FromJSON ApiConfig

Methods

parseJSON :: Value -> Parser ApiConfig

parseJSONList :: Value -> Parser [ApiConfig]

data ApiStatus

Constructors

Development

Stable

Deprecated

Instances

Eq ApiStatus

Methods

(==) :: ApiStatus -> ApiStatus -> Bool

(/=) :: ApiStatus -> ApiStatus -> Bool

Show ApiStatus

Methods

showsPrec :: Int -> ApiStatus -> ShowS

show :: ApiStatus -> String

showList :: [ApiStatus] -> ShowS

FromJSON ApiStatus

Methods

parseJSON :: Value -> Parser ApiStatus

parseJSONList :: Value -> Parser [ApiStatus]

data AuthStatus

Constructors

Guest

Untrusted

Trusted

Instances

Eq AuthStatus

Methods

(==) :: AuthStatus -> AuthStatus -> Bool

(/=) :: AuthStatus -> AuthStatus -> Bool

Show AuthStatus

Methods

showsPrec :: Int -> AuthStatus -> ShowS

show :: AuthStatus -> String

showList :: [AuthStatus] -> ShowS

FromJSON AuthStatus

Methods

parseJSON :: Value -> Parser AuthStatus

parseJSONList :: Value -> Parser [AuthStatus]

newtype ApiVersion

LXD API version string, e.g. 1.0.

Constructors

ApiVersion String

Instances

Eq ApiVersion

Methods

(==) :: ApiVersion -> ApiVersion -> Bool

(/=) :: ApiVersion -> ApiVersion -> Bool

Show ApiVersion

Methods

showsPrec :: Int -> ApiVersion -> ShowS

show :: ApiVersion -> String

showList :: [ApiVersion] -> ShowS

FromJSON ApiVersion

Methods

parseJSON :: Value -> Parser ApiVersion

parseJSONList :: Value -> Parser [ApiVersion]

data ApiExtension

LXD API extension identifier.

Constructors

ExtPatch

ExtCertificateUpdate

ExtContainerExecRecording

ExtFileAppend

ExtFileDelete

ExtContainerEditMetadata

ExtImageCreateAliases

ExtNetwork

ExtStorage

ExtOther String

Instances

Eq ApiExtension

Methods

(==) :: ApiExtension -> ApiExtension -> Bool

(/=) :: ApiExtension -> ApiExtension -> Bool

Ord ApiExtension

Methods

compare :: ApiExtension -> ApiExtension -> Ordering

(<) :: ApiExtension -> ApiExtension -> Bool

(<=) :: ApiExtension -> ApiExtension -> Bool

(>) :: ApiExtension -> ApiExtension -> Bool

(>=) :: ApiExtension -> ApiExtension -> Bool

max :: ApiExtension -> ApiExtension -> ApiExtension

min :: ApiExtension -> ApiExtension -> ApiExtension

Show ApiExtension

Methods

showsPrec :: Int -> ApiExtension -> ShowS

show :: ApiExtension -> String

showList :: [ApiExtension] -> ShowS

ToJSON ApiExtension

Methods

toJSON :: ApiExtension -> Value

toEncoding :: ApiExtension -> Encoding

toJSONList :: [ApiExtension] -> Value

toEncodingList :: [ApiExtension] -> Encoding

FromJSON ApiExtension

Methods

parseJSON :: Value -> Parser ApiExtension

parseJSONList :: Value -> Parser [ApiExtension]

Certificates

newtype CertificateHash

LXD trusted certificate hash.

Constructors

CertificateHash String

Instances

Eq CertificateHash

Methods

(==) :: CertificateHash -> CertificateHash -> Bool

(/=) :: CertificateHash -> CertificateHash -> Bool

Show CertificateHash

Methods

showsPrec :: Int -> CertificateHash -> ShowS

show :: CertificateHash -> String

showList :: [CertificateHash] -> ShowS

FromJSON CertificateHash

Methods

parseJSON :: Value -> Parser CertificateHash

parseJSONList :: Value -> Parser [CertificateHash]

Containers

Querying information

newtype ContainerName

LXD container name.

Constructors

ContainerName String

Instances

Eq ContainerName

Methods

(==) :: ContainerName -> ContainerName -> Bool

(/=) :: ContainerName -> ContainerName -> Bool

Show ContainerName

Methods

showsPrec :: Int -> ContainerName -> ShowS

show :: ContainerName -> String

showList :: [ContainerName] -> ShowS

IsString ContainerName

Methods

fromString :: String -> ContainerName

ToJSON ContainerName

Methods

toJSON :: ContainerName -> Value

toEncoding :: ContainerName -> Encoding

toJSONList :: [ContainerName] -> Value

toEncodingList :: [ContainerName] -> Encoding

FromJSON ContainerName

Methods

parseJSON :: Value -> Parser ContainerName

parseJSONList :: Value -> Parser [ContainerName]

ToHttpApiData ContainerName

Methods

toUrlPiece :: ContainerName -> Text

toEncodedUrlPiece :: ContainerName -> Builder

toHeader :: ContainerName -> ByteString

toQueryParam :: ContainerName -> Text

data Container

LXD container information.

Returned when querying GET /1.0/containers/<name>.

Constructors

Container

Fields

• containerArchitecture :: String
• containerName :: String
• containerConfig :: Map String String
• containerCreatedAt :: String
• containerDevices :: Map String (Map String String)
• containerEphemeral :: Bool
• containerProfiles :: [String]
• containerStateful :: Bool
• containerExpandedConfig :: Map String String
• containerExpandedDevices :: Map String (Map String String)
• containerStatus :: String
• containerSatusCode :: Int
• containerLastUsedAt :: String

Instances

Show Container

Methods

showsPrec :: Int -> Container -> ShowS

show :: Container -> String

showList :: [Container] -> ShowS

FromJSON Container

Methods

parseJSON :: Value -> Parser Container

parseJSONList :: Value -> Parser [Container]

Configuration

data ContainerPut

Used to set the configuration of an LXD container.

Used when querying PUT /1.0/containers/<name>.

Constructors

ContainerPut

Fields

• containerPutArchitecture :: String
• containerPutConfig :: Map String String
• containerPutDevices :: Map String (Map String String)
• containerPutEphemeral :: Bool
• containerPutProfiles :: [String]

Instances

Show ContainerPut

Methods

showsPrec :: Int -> ContainerPut -> ShowS

show :: ContainerPut -> String

showList :: [ContainerPut] -> ShowS

ToJSON ContainerPut

Methods

toJSON :: ContainerPut -> Value

toEncoding :: ContainerPut -> Encoding

toJSONList :: [ContainerPut] -> Value

toEncodingList :: [ContainerPut] -> Encoding

data ContainerPatch

Used to patch the configuration of an LXD container.

Used when querying PATCH /1.0/containers/<name>.

Constructors

ContainerPatch

Fields

• containerPatchArchitecture :: Maybe String
• containerPatchConfig :: Maybe (Map String String)
• containerPatchDevices :: Maybe (Map String (Map String String))
• containerPatchEphemeral :: Maybe Bool
• containerPatchProfiles :: Maybe [String]

Instances

Show ContainerPatch

Methods

showsPrec :: Int -> ContainerPatch -> ShowS

show :: ContainerPatch -> String

showList :: [ContainerPatch] -> ShowS

ToJSON ContainerPatch

Methods

toJSON :: ContainerPatch -> Value

toEncoding :: ContainerPatch -> Encoding

toJSONList :: [ContainerPatch] -> Value

toEncodingList :: [ContainerPatch] -> Encoding

newtype ContainerRename

Used to rename a container to the given name.

Used when querying POST /1.0/containers/<name>.

Constructors

ContainerRename String

Instances

Show ContainerRename

Methods

showsPrec :: Int -> ContainerRename -> ShowS

show :: ContainerRename -> String

showList :: [ContainerRename] -> ShowS

ToJSON ContainerRename

Methods

toJSON :: ContainerRename -> Value

toEncoding :: ContainerRename -> Encoding

toJSONList :: [ContainerRename] -> Value

toEncodingList :: [ContainerRename] -> Encoding

State

data MemoryState

Memory state of an LXD container. As used by ContainerState.

Constructors

MemoryState

Fields

• memoryStateUsage :: Integer
• memoryStateUsagePeak :: Integer
• memoryStateSwapUsage :: Integer
• memoryStateSwapUsagePeak :: Integer

Instances

Show MemoryState

Methods

showsPrec :: Int -> MemoryState -> ShowS

show :: MemoryState -> String

showList :: [MemoryState] -> ShowS

FromJSON MemoryState

Methods

parseJSON :: Value -> Parser MemoryState

parseJSONList :: Value -> Parser [MemoryState]

data NetworkState

Network state of an LXD container network device. As used by ContainerState.

Constructors

NetworkState

Fields

• networkStateAddresses :: [NetworkAddress]
• networkStateCounters :: NetworkCounters
• networkStateHwaddr :: String
• networkStateHostName :: String
• networkStateMtu :: Int
• networkStateState :: String
• networkStateType :: String

Instances

Show NetworkState

Methods

showsPrec :: Int -> NetworkState -> ShowS

show :: NetworkState -> String

showList :: [NetworkState] -> ShowS

FromJSON NetworkState

Methods

parseJSON :: Value -> Parser NetworkState

parseJSONList :: Value -> Parser [NetworkState]

data NetworkAddress

Network address of an LXD container network device. As used by NetworkState.

Constructors

NetworkAddress

Fields

• networkAddressFamily :: String
• networkAddressAddress :: String
• networkAddressNetmask :: String
• networkAddressScope :: String

Instances

Show NetworkAddress

Methods

showsPrec :: Int -> NetworkAddress -> ShowS

show :: NetworkAddress -> String

showList :: [NetworkAddress] -> ShowS

FromJSON NetworkAddress

Methods

parseJSON :: Value -> Parser NetworkAddress

parseJSONList :: Value -> Parser [NetworkAddress]

data NetworkCounters

Collection of statistics of an LXD container network device. As used by NetworkState.

Constructors

NetworkCounters

Fields

• networkCountersBytesReceived :: Integer
• networkCountersBytesSent :: Integer
• networkCountersPacketsReceived :: Integer
• networkCountersPacketsSent :: Integer

Instances

Show NetworkCounters

Methods

showsPrec :: Int -> NetworkCounters -> ShowS

show :: NetworkCounters -> String

showList :: [NetworkCounters] -> ShowS

FromJSON NetworkCounters

Methods

parseJSON :: Value -> Parser NetworkCounters

parseJSONList :: Value -> Parser [NetworkCounters]

data ContainerState

State of an LXD container.

Used when querying GET /1.0/container/<name>/state.

Constructors

ContainerState

Fields

• containerStateStatus :: String
• containerStateStatusCode :: StatusCode
• containerStateCpu :: Integer
• containerStateDisk :: Map String Integer
• containerStateMemory :: MemoryState
• containerStateNetwork :: Map String NetworkState
• containerStatePid :: Int
• containerStateProcesses :: Int

Instances

Show ContainerState

Methods

showsPrec :: Int -> ContainerState -> ShowS

show :: ContainerState -> String

showList :: [ContainerState] -> ShowS

FromJSON ContainerState

Methods

parseJSON :: Value -> Parser ContainerState

parseJSONList :: Value -> Parser [ContainerState]

data StateAction

State change action for an LXD container, as used by ContainerPutState.

Constructors

Stop

Start

Restart

Freeze

Unfreeze

Instances

Eq StateAction

Methods

(==) :: StateAction -> StateAction -> Bool

(/=) :: StateAction -> StateAction -> Bool

Show StateAction

Methods

showsPrec :: Int -> StateAction -> ShowS

show :: StateAction -> String

showList :: [StateAction] -> ShowS

ToJSON StateAction

Methods

toJSON :: StateAction -> Value

toEncoding :: StateAction -> Encoding

toJSONList :: [StateAction] -> Value

toEncodingList :: [StateAction] -> Encoding

data ContainerPutState

State change request for an LXD container.

Used when querying PUT /1.0/container/<name>/state.

Constructors

ContainerPutState

Fields

• containerPutStateAction :: StateAction
• containerPutStateTimeout :: Int
• containerPutStateForce :: Bool
• containerPutStateStateful :: Bool

Instances

Show ContainerPutState

Methods

showsPrec :: Int -> ContainerPutState -> ShowS

show :: ContainerPutState -> String

showList :: [ContainerPutState] -> ShowS

ToJSON ContainerPutState

Methods

toJSON :: ContainerPutState -> Value

toEncoding :: ContainerPutState -> Encoding

toJSONList :: [ContainerPutState] -> Value

toEncodingList :: [ContainerPutState] -> Encoding

containerNewState :: StateAction -> Bool -> ContainerPutState

Creating containers

data ContainerCreateRequest

LXD create container request object.

Used when querying POST /1.0/containers.

Constructors

ContainerCreateRequest

Fields

• containerCreateRequestName :: String
• containerCreateRequestArchitecture :: String
• containerCreateRequestProfiles :: [String]
• containerCreateRequestEphemeral :: Bool
• containerCreateRequestConfig :: Map String String
• containerCreateRequestDevices :: Map String (Map String String)
• containerCreateRequestInstanceType :: Maybe String
• containerCreateRequestSource :: ContainerSource

Instances

Show ContainerCreateRequest

Methods

showsPrec :: Int -> ContainerCreateRequest -> ShowS

show :: ContainerCreateRequest -> String

showList :: [ContainerCreateRequest] -> ShowS

ToJSON ContainerCreateRequest

Methods

toJSON :: ContainerCreateRequest -> Value

toEncoding :: ContainerCreateRequest -> Encoding

toJSONList :: [ContainerCreateRequest] -> Value

toEncodingList :: [ContainerCreateRequest] -> Encoding

containerCreateRequest :: String -> ContainerSource -> ContainerCreateRequest

Create a default ContainerCreateRequest.

data ContainerSource

Source for creating a container, as used by ContainerCreateRequest.

Constructors

ContainerSourceLocalByAlias LocalImageByAlias

Container based on a local image with a certain alias.

ContainerSourceLocalByFingerprint LocalImageByFingerprint

Container based on a local image with a certain alias.

ContainerSourceNone

Container without a pre-populated rootfs.

ContainerSourceRemote RemoteImage

Continer based on a public remote image.

Instances

Show ContainerSource

Methods

showsPrec :: Int -> ContainerSource -> ShowS

show :: ContainerSource -> String

showList :: [ContainerSource] -> ShowS

ToJSON ContainerSource

Methods

toJSON :: ContainerSource -> Value

toEncoding :: ContainerSource -> Encoding

toJSONList :: [ContainerSource] -> Value

toEncodingList :: [ContainerSource] -> Encoding

Deleting containers

data ContainerDeleteRequest

LXD delete container request object.

Used when querying DELETE /1.0/containers/<name>.

Constructors

ContainerDeleteRequest

Instances

ToJSON ContainerDeleteRequest

Methods

toJSON :: ContainerDeleteRequest -> Value

toEncoding :: ContainerDeleteRequest -> Encoding

toJSONList :: [ContainerDeleteRequest] -> Value

toEncodingList :: [ContainerDeleteRequest] -> Encoding

Default ContainerDeleteRequest

Methods

def :: ContainerDeleteRequest

Executing commands

data ExecParams

Configuration parameter to ExecRequest and ExecResponse.

Constructors

ExecImmediate

Don't wait for a websocket connection before executing.

ExecWebsocketInteractive

Wait for websocket, allocate PTY.

ExecWebsocketNonInteractive

Wait for websocket, don't allocate PTY.

Instances

Show ExecParams

Methods

showsPrec :: Int -> ExecParams -> ShowS

show :: ExecParams -> String

showList :: [ExecParams] -> ShowS

data ExecRequest params

LXD container exec request, configured using ExecParams as type parameter.

Request body when querying POST /1.0/containers/<name>/exec.

Constructors

ExecRequest

Fields

• execRequestCommand :: [String]
• execRequestEnvironment :: Map String String
• execRequestRecordOutput :: Bool
• execRequestWidth :: Int
• execRequestHeight :: Int

Instances

Show (ExecRequest params)

Methods

showsPrec :: Int -> ExecRequest params -> ShowS

show :: ExecRequest params -> String

showList :: [ExecRequest params] -> ShowS

ToJSON (ExecRequest ExecImmediate)

Methods

toJSON :: ExecRequest ExecImmediate -> Value

toEncoding :: ExecRequest ExecImmediate -> Encoding

toJSONList :: [ExecRequest ExecImmediate] -> Value

toEncodingList :: [ExecRequest ExecImmediate] -> Encoding

ToJSON (ExecRequest ExecWebsocketInteractive)

Methods

toJSON :: ExecRequest ExecWebsocketInteractive -> Value

toEncoding :: ExecRequest ExecWebsocketInteractive -> Encoding

toJSONList :: [ExecRequest ExecWebsocketInteractive] -> Value

toEncodingList :: [ExecRequest ExecWebsocketInteractive] -> Encoding

ToJSON (ExecRequest ExecWebsocketNonInteractive)

Methods

toJSON :: ExecRequest ExecWebsocketNonInteractive -> Value

toEncoding :: ExecRequest ExecWebsocketNonInteractive -> Encoding

toJSONList :: [ExecRequest ExecWebsocketNonInteractive] -> Value

toEncodingList :: [ExecRequest ExecWebsocketNonInteractive] -> Encoding

Default (ExecRequest a)

Methods

def :: ExecRequest a

type ExecResponseMetadataImmediate = Value

Metadata of an immediate exec response.

Returned when querying POST /1.0/containers/<name>/exec with ExecImmediate as configuration.

newtype ExecResponseMetadataWebsocket fdset

Metadata of a websocket exec repsonse.

Returned when querying POST /1.0/containers/<name>/exec with ExecWebsocketInteractive or ExecWebsocketNonInteractive as configuration.

Paramtrized by a file descriptor set FdSet, see also the type family ExecFds.

Constructors

ExecResponseMetadataWebsocket

Fields

• execResponseMetadataWebsocketFds :: Fds fdset

Instances

Show (ExecResponseMetadataWebsocket fdset)

Methods

showsPrec :: Int -> ExecResponseMetadataWebsocket fdset -> ShowS

show :: ExecResponseMetadataWebsocket fdset -> String

showList :: [ExecResponseMetadataWebsocket fdset] -> ShowS

FromJSON (ExecResponseMetadataWebsocket FdAll)

Methods

parseJSON :: Value -> Parser (ExecResponseMetadataWebsocket FdAll)

parseJSONList :: Value -> Parser [ExecResponseMetadataWebsocket FdAll]

FromJSON (ExecResponseMetadataWebsocket FdPty)

Methods

parseJSON :: Value -> Parser (ExecResponseMetadataWebsocket FdPty)

parseJSONList :: Value -> Parser [ExecResponseMetadataWebsocket FdPty]

type family ExecResponseMetadata (params :: ExecParams) :: * where ...

Type family converting an ExecParams to the corresponding response type.

Equations

ExecResponseMetadata ExecImmediate = ExecResponseMetadataImmediate

ExecResponseMetadata ExecWebsocketInteractive = ExecResponseMetadataWebsocket FdPty

ExecResponseMetadata ExecWebsocketNonInteractive = ExecResponseMetadataWebsocket FdAll

Working with file descriptors

newtype Secret

A secret used to connect to a websocket.

Constructors

Secret String

Instances

Eq Secret

Methods

(==) :: Secret -> Secret -> Bool

(/=) :: Secret -> Secret -> Bool

Show Secret

Methods

showsPrec :: Int -> Secret -> ShowS

show :: Secret -> String

showList :: [Secret] -> ShowS

FromJSON Secret

Methods

parseJSON :: Value -> Parser Secret

parseJSONList :: Value -> Parser [Secret]

data FdSet

A set of selected file descriptors.

Constructors

FdAll

FdPty

Instances

Show FdSet

Methods

showsPrec :: Int -> FdSet -> ShowS

show :: FdSet -> String

showList :: [FdSet] -> ShowS

data Fds set where

A set of file descriptors.

Constructors

FdsAll :: {..} -> Fds FdAll

Fields

• fdsAllStdin :: Secret
• fdsAllStdout :: Secret
• fdsAllStderr :: Secret
• fdsAllControl :: Secret

FdsPty :: {..} -> Fds FdPty

Fields

• fdsPty :: Secret
• fdsPtyControl :: Secret

Instances

Show (Fds set)

Methods

showsPrec :: Int -> Fds set -> ShowS

show :: Fds set -> String

showList :: [Fds set] -> ShowS

FromJSON (Fds FdAll)

Methods

parseJSON :: Value -> Parser (Fds FdAll)

parseJSONList :: Value -> Parser [Fds FdAll]

FromJSON (Fds FdPty)

Methods

parseJSON :: Value -> Parser (Fds FdPty)

parseJSONList :: Value -> Parser [Fds FdPty]

type family ExecFds (params :: ExecParams) :: FdSet where ...

Type family converting an ExecParams to an FdSet.

Equations

ExecFds ExecWebsocketInteractive = FdPty

ExecFds ExecWebsocketNonInteractive = FdAll

Working with files

newtype Gid

Group ID of a container file.

Constructors

Gid Int

Instances

Bounded Gid

Methods

minBound :: Gid

maxBound :: Gid

Enum Gid

Methods

succ :: Gid -> Gid

pred :: Gid -> Gid

toEnum :: Int -> Gid

fromEnum :: Gid -> Int

enumFrom :: Gid -> [Gid]

enumFromThen :: Gid -> Gid -> [Gid]

enumFromTo :: Gid -> Gid -> [Gid]

enumFromThenTo :: Gid -> Gid -> Gid -> [Gid]

Eq Gid

Methods

(==) :: Gid -> Gid -> Bool

(/=) :: Gid -> Gid -> Bool

Integral Gid

Methods

quot :: Gid -> Gid -> Gid

rem :: Gid -> Gid -> Gid

div :: Gid -> Gid -> Gid

mod :: Gid -> Gid -> Gid

quotRem :: Gid -> Gid -> (Gid, Gid)

divMod :: Gid -> Gid -> (Gid, Gid)

toInteger :: Gid -> Integer

Num Gid

Methods

(+) :: Gid -> Gid -> Gid

(-) :: Gid -> Gid -> Gid

(*) :: Gid -> Gid -> Gid

negate :: Gid -> Gid

abs :: Gid -> Gid

signum :: Gid -> Gid

fromInteger :: Integer -> Gid

Ord Gid

Methods

compare :: Gid -> Gid -> Ordering

(<) :: Gid -> Gid -> Bool

(<=) :: Gid -> Gid -> Bool

(>) :: Gid -> Gid -> Bool

(>=) :: Gid -> Gid -> Bool

max :: Gid -> Gid -> Gid

min :: Gid -> Gid -> Gid

Read Gid

Methods

readsPrec :: Int -> ReadS Gid

readList :: ReadS [Gid]

readPrec :: ReadPrec Gid

readListPrec :: ReadPrec [Gid]

Real Gid

Methods

toRational :: Gid -> Rational

Show Gid

Methods

showsPrec :: Int -> Gid -> ShowS

show :: Gid -> String

showList :: [Gid] -> ShowS

ToHttpApiData Gid

Methods

toUrlPiece :: Gid -> Text

toEncodedUrlPiece :: Gid -> Builder

toHeader :: Gid -> ByteString

toQueryParam :: Gid -> Text

FromHttpApiData Gid

Methods

parseUrlPiece :: Text -> Either Text Gid

parseHeader :: ByteString -> Either Text Gid

parseQueryParam :: Text -> Either Text Gid

newtype Uid

User ID of a container file.

Constructors

Uid Int

Instances

Bounded Uid

Methods

minBound :: Uid

maxBound :: Uid

Enum Uid

Methods

succ :: Uid -> Uid

pred :: Uid -> Uid

toEnum :: Int -> Uid

fromEnum :: Uid -> Int

enumFrom :: Uid -> [Uid]

enumFromThen :: Uid -> Uid -> [Uid]

enumFromTo :: Uid -> Uid -> [Uid]

enumFromThenTo :: Uid -> Uid -> Uid -> [Uid]

Eq Uid

Methods

(==) :: Uid -> Uid -> Bool

(/=) :: Uid -> Uid -> Bool

Integral Uid

Methods

quot :: Uid -> Uid -> Uid

rem :: Uid -> Uid -> Uid

div :: Uid -> Uid -> Uid

mod :: Uid -> Uid -> Uid

quotRem :: Uid -> Uid -> (Uid, Uid)

divMod :: Uid -> Uid -> (Uid, Uid)

toInteger :: Uid -> Integer

Num Uid

Methods

(+) :: Uid -> Uid -> Uid

(-) :: Uid -> Uid -> Uid

(*) :: Uid -> Uid -> Uid

negate :: Uid -> Uid

abs :: Uid -> Uid

signum :: Uid -> Uid

fromInteger :: Integer -> Uid

Ord Uid

Methods

compare :: Uid -> Uid -> Ordering

(<) :: Uid -> Uid -> Bool

(<=) :: Uid -> Uid -> Bool

(>) :: Uid -> Uid -> Bool

(>=) :: Uid -> Uid -> Bool

max :: Uid -> Uid -> Uid

min :: Uid -> Uid -> Uid

Read Uid

Methods

readsPrec :: Int -> ReadS Uid

readList :: ReadS [Uid]

readPrec :: ReadPrec Uid

readListPrec :: ReadPrec [Uid]

Real Uid

Methods

toRational :: Uid -> Rational

Show Uid

Methods

showsPrec :: Int -> Uid -> ShowS

show :: Uid -> String

showList :: [Uid] -> ShowS

ToHttpApiData Uid

Methods

toUrlPiece :: Uid -> Text

toEncodedUrlPiece :: Uid -> Builder

toHeader :: Uid -> ByteString

toQueryParam :: Uid -> Text

FromHttpApiData Uid

Methods

parseUrlPiece :: Text -> Either Text Uid

parseHeader :: ByteString -> Either Text Uid

parseQueryParam :: Text -> Either Text Uid

newtype FileMode

Mode of a container file. Encoded in standard octal notation, e.g. 0644.

Constructors

FileMode String

Instances

Eq FileMode

Methods

(==) :: FileMode -> FileMode -> Bool

(/=) :: FileMode -> FileMode -> Bool

Ord FileMode

Methods

compare :: FileMode -> FileMode -> Ordering

(<) :: FileMode -> FileMode -> Bool

(<=) :: FileMode -> FileMode -> Bool

(>) :: FileMode -> FileMode -> Bool

(>=) :: FileMode -> FileMode -> Bool

max :: FileMode -> FileMode -> FileMode

min :: FileMode -> FileMode -> FileMode

Read FileMode

Methods

readsPrec :: Int -> ReadS FileMode

readList :: ReadS [FileMode]

readPrec :: ReadPrec FileMode

readListPrec :: ReadPrec [FileMode]

Show FileMode

Methods

showsPrec :: Int -> FileMode -> ShowS

show :: FileMode -> String

showList :: [FileMode] -> ShowS

IsString FileMode

Methods

fromString :: String -> FileMode

ToHttpApiData FileMode

Methods

toUrlPiece :: FileMode -> Text

toEncodedUrlPiece :: FileMode -> Builder

toHeader :: FileMode -> ByteString

toQueryParam :: FileMode -> Text

FromHttpApiData FileMode

Methods

parseUrlPiece :: Text -> Either Text FileMode

parseHeader :: ByteString -> Either Text FileMode

parseQueryParam :: Text -> Either Text FileMode

newtype FileType

Type of a container file. Can be one of directory, file or symlink.

Constructors

FileType String

Instances

Eq FileType

Methods

(==) :: FileType -> FileType -> Bool

(/=) :: FileType -> FileType -> Bool

Ord FileType

Methods

compare :: FileType -> FileType -> Ordering

(<) :: FileType -> FileType -> Bool

(<=) :: FileType -> FileType -> Bool

(>) :: FileType -> FileType -> Bool

(>=) :: FileType -> FileType -> Bool

max :: FileType -> FileType -> FileType

min :: FileType -> FileType -> FileType

Read FileType

Methods

readsPrec :: Int -> ReadS FileType

readList :: ReadS [FileType]

readPrec :: ReadPrec FileType

readListPrec :: ReadPrec [FileType]

Show FileType

Methods

showsPrec :: Int -> FileType -> ShowS

show :: FileType -> String

showList :: [FileType] -> ShowS

IsString FileType

Methods

fromString :: String -> FileType

ToHttpApiData FileType

Methods

toUrlPiece :: FileType -> Text

toEncodedUrlPiece :: FileType -> Builder

toHeader :: FileType -> ByteString

toQueryParam :: FileType -> Text

FromHttpApiData FileType

Methods

parseUrlPiece :: Text -> Either Text FileType

parseHeader :: ByteString -> Either Text FileType

parseQueryParam :: Text -> Either Text FileType

data RawFileResponse

Raw file response, not yet decoded, used because of a bug in Servant.

Use headers to get actual content type.

Constructors

RawFileResponse MediaType ByteString

Instances

Show RawFileResponse

Methods

showsPrec :: Int -> RawFileResponse -> ShowS

show :: RawFileResponse -> String

showList :: [RawFileResponse] -> ShowS

MimeUnrender * JsonOrBinary RawFileResponse

Methods

mimeUnrender :: Proxy JsonOrBinary RawFileResponse -> ByteString -> Either String a

mimeUnrenderWithType :: Proxy JsonOrBinary RawFileResponse -> MediaType -> ByteString -> Either String a

rawFileResponseBody :: RawFileResponse -> ByteString

Get the body of a RawFileResponse.

fileResponse :: FileType -> ByteString -> Either String FileResponse

Construct a file response from a type and a ByteString.

data FileResponse

LXD file response object, representing either a file or a directory.

Used by the GET /1.0/containers/<name>/files/<filename> endpoints.

Constructors

File ByteString

Directory (Response [String])

Instances

Show FileResponse

Methods

showsPrec :: Int -> FileResponse -> ShowS

show :: FileResponse -> String

showList :: [FileResponse] -> ShowS

FromJSON FileResponse

Methods

parseJSON :: Value -> Parser FileResponse

parseJSONList :: Value -> Parser [FileResponse]

data PathResponse

LXD path response object, which is a file and metadata.

Used by the /1.0/containers/<name>/files/... endpoints.

Constructors

PathResponse

Fields

• pathUid :: Uid
• pathGid :: Gid
• pathMode :: FileMode
• pathType :: FileType
• getFile :: FileResponse

Instances

Show PathResponse

Methods

showsPrec :: Int -> PathResponse -> ShowS

show :: PathResponse -> String

showList :: [PathResponse] -> ShowS

Referencing containers

newtype LocalContainer

Reference to a local container, as used by ImageSource.

Constructors

LocalContainer ContainerName

Instances

Show LocalContainer

Methods

showsPrec :: Int -> LocalContainer -> ShowS

show :: LocalContainer -> String

showList :: [LocalContainer] -> ShowS

IsString LocalContainer

Methods

fromString :: String -> LocalContainer

Images

Querying information

newtype ImageId

LXD image identifier.

Constructors

ImageId String

Instances

Eq ImageId

Methods

(==) :: ImageId -> ImageId -> Bool

(/=) :: ImageId -> ImageId -> Bool

Show ImageId

Methods

showsPrec :: Int -> ImageId -> ShowS

show :: ImageId -> String

showList :: [ImageId] -> ShowS

ToJSON ImageId

Methods

toJSON :: ImageId -> Value

toEncoding :: ImageId -> Encoding

toJSONList :: [ImageId] -> Value

toEncodingList :: [ImageId] -> Encoding

FromJSON ImageId

Methods

parseJSON :: Value -> Parser ImageId

parseJSONList :: Value -> Parser [ImageId]

ToHttpApiData ImageId

Methods

toUrlPiece :: ImageId -> Text

toEncodedUrlPiece :: ImageId -> Builder

toHeader :: ImageId -> ByteString

toQueryParam :: ImageId -> Text

data Image

LXD image information.

Returned when querying GET /1.0/images/<fingerprint>.

Constructors

Image

Fields

• imageAllAliases :: [ImageAlias]
• imageArchitecture :: String
• imageAutoUpdate :: Bool
• imageCached :: Bool
• imageFingerprint :: String
• imageFilename :: String
• imageProperties :: ImageProperties
• imagePublic :: Bool
• imageSize :: Integer
• imageCreatedAt :: String
• imageExpiresAt :: String
• imageLastUsedAt :: String
• imageUplaodedAt :: String

Instances

Show Image

Methods

showsPrec :: Int -> Image -> ShowS

show :: Image -> String

showList :: [Image] -> ShowS

FromJSON Image

Methods

parseJSON :: Value -> Parser Image

parseJSONList :: Value -> Parser [Image]

data ImageAlias

Alias of an image.

Returned when querying GET /1.0/images/aliases/<name>, and as a part of GET /1.0/images/<fingerprint>.

Constructors

ImageAlias

Fields

• imageAliasName :: String
• imageAliasDescription :: String
• imageAliasTarget :: Maybe String

Instances

Show ImageAlias

Methods

showsPrec :: Int -> ImageAlias -> ShowS

show :: ImageAlias -> String

showList :: [ImageAlias] -> ShowS

ToJSON ImageAlias

Methods

toJSON :: ImageAlias -> Value

toEncoding :: ImageAlias -> Encoding

toJSONList :: [ImageAlias] -> Value

toEncodingList :: [ImageAlias] -> Encoding

FromJSON ImageAlias

Methods

parseJSON :: Value -> Parser ImageAlias

parseJSONList :: Value -> Parser [ImageAlias]

defaultImageAlias :: String -> ImageAlias

Create a default ImageAlias, with empty description and target.

data ImageProperties

Properties of an image.

Constructors

ImageProperties

Fields

• imagePropertiesArchitecture :: Maybe String
• imagePropertiesDescription :: Maybe String
• imagePropertiesOs :: Maybe String
• imagePropertiesRelease :: Maybe String

Instances

Show ImageProperties

Methods

showsPrec :: Int -> ImageProperties -> ShowS

show :: ImageProperties -> String

showList :: [ImageProperties] -> ShowS

FromJSON ImageProperties

Methods

parseJSON :: Value -> Parser ImageProperties

parseJSONList :: Value -> Parser [ImageProperties]

newtype ImageAliasName

LXD alias name.

Returned when querying GET /1.0/images/aliases.

Constructors

ImageAliasName String

Instances

Eq ImageAliasName

Methods

(==) :: ImageAliasName -> ImageAliasName -> Bool

(/=) :: ImageAliasName -> ImageAliasName -> Bool

Show ImageAliasName

Methods

showsPrec :: Int -> ImageAliasName -> ShowS

show :: ImageAliasName -> String

showList :: [ImageAliasName] -> ShowS

IsString ImageAliasName

Methods

fromString :: String -> ImageAliasName

ToJSON ImageAliasName

Methods

toJSON :: ImageAliasName -> Value

toEncoding :: ImageAliasName -> Encoding

toJSONList :: [ImageAliasName] -> Value

toEncodingList :: [ImageAliasName] -> Encoding

FromJSON ImageAliasName

Methods

parseJSON :: Value -> Parser ImageAliasName

parseJSONList :: Value -> Parser [ImageAliasName]

ToHttpApiData ImageAliasName

Methods

toUrlPiece :: ImageAliasName -> Text

toEncodedUrlPiece :: ImageAliasName -> Builder

toHeader :: ImageAliasName -> ByteString

toQueryParam :: ImageAliasName -> Text

Creating and publishing new images

data ImageCreateRequest

LXD image create request object.

Used when querying POST /1.0/images.

Constructors

ImageCreateRequest

Fields

• imageCreateRequestPublic :: Bool
• imageCreateRequestAutoUpdate :: Bool
• imageCreateRequestProperties :: Value
• imageCreateRequestAliases :: [ImageAlias]
• imageCreateRequestSource :: ImageSource

Instances

Show ImageCreateRequest

Methods

showsPrec :: Int -> ImageCreateRequest -> ShowS

show :: ImageCreateRequest -> String

showList :: [ImageCreateRequest] -> ShowS

ToJSON ImageCreateRequest

Methods

toJSON :: ImageCreateRequest -> Value

toEncoding :: ImageCreateRequest -> Encoding

toJSONList :: [ImageCreateRequest] -> Value

toEncodingList :: [ImageCreateRequest] -> Encoding

imageCreateRequest :: ImageSource -> ImageCreateRequest

Construct a new default ImageCreateRequest.

data ImageSource

A generic image source, used by ImageCreateRequest.

Constructors

ImageSourceRemoteImage RemoteImage

ImageSourceLocalContainer LocalContainer

Instances

Show ImageSource

Methods

showsPrec :: Int -> ImageSource -> ShowS

show :: ImageSource -> String

showList :: [ImageSource] -> ShowS

ToJSON ImageSource

Methods

toJSON :: ImageSource -> Value

toEncoding :: ImageSource -> Encoding

toJSONList :: [ImageSource] -> Value

toEncodingList :: [ImageSource] -> Encoding

Deleting images

data ImageDeleteRequest

LXD image delete request object.

Used when querying DELETE /1.0/images/<fingerprint>.

Constructors

ImageDeleteRequest

Instances

ToJSON ImageDeleteRequest

Methods

toJSON :: ImageDeleteRequest -> Value

toEncoding :: ImageDeleteRequest -> Encoding

toJSONList :: [ImageDeleteRequest] -> Value

toEncodingList :: [ImageDeleteRequest] -> Encoding

Default ImageDeleteRequest

Methods

def :: ImageDeleteRequest

Referencing images

newtype LocalImageByAlias

Source for a local image, specified by its alias.

Constructors

LocalImageByAlias ImageAliasName

Instances

Show LocalImageByAlias

Methods

showsPrec :: Int -> LocalImageByAlias -> ShowS

show :: LocalImageByAlias -> String

showList :: [LocalImageByAlias] -> ShowS

IsString LocalImageByAlias

Methods

fromString :: String -> LocalImageByAlias

newtype LocalImageByFingerprint

Source for a local image, specified by its fingerprint

Constructors

LocalImageByFingerprint ImageId

Instances

Show LocalImageByFingerprint

Methods

showsPrec :: Int -> LocalImageByFingerprint -> ShowS

show :: LocalImageByFingerprint -> String

showList :: [LocalImageByFingerprint] -> ShowS

data RemoteImage

Source for an image from a public or private remote.

Constructors

RemoteImage

Fields

• remoteImageServer :: String
• remoteImageSecret :: Maybe String
• remoteImageCertificate :: Maybe String
• remoteImageAliasOrFingerprint :: Either ImageAliasName ImageId

Instances

Show RemoteImage

Methods

showsPrec :: Int -> RemoteImage -> ShowS

show :: RemoteImage -> String

showList :: [RemoteImage] -> ShowS

remoteImage :: String -> ImageAliasName -> RemoteImage

Create a remote image reference form a public remote.

remoteImageId :: String -> ImageId -> RemoteImage

Create a remote image reference form a public remote, using an image ID.

Networks

newtype NetworkName

LXD network name.

Constructors

NetworkName String

Instances

Eq NetworkName

Methods

(==) :: NetworkName -> NetworkName -> Bool

(/=) :: NetworkName -> NetworkName -> Bool

Show NetworkName

Methods

showsPrec :: Int -> NetworkName -> ShowS

show :: NetworkName -> String

showList :: [NetworkName] -> ShowS

IsString NetworkName

Methods

fromString :: String -> NetworkName

ToJSON NetworkName

Methods

toJSON :: NetworkName -> Value

toEncoding :: NetworkName -> Encoding

toJSONList :: [NetworkName] -> Value

toEncodingList :: [NetworkName] -> Encoding

FromJSON NetworkName

Methods

parseJSON :: Value -> Parser NetworkName

parseJSONList :: Value -> Parser [NetworkName]

ToHttpApiData NetworkName

Methods

toUrlPiece :: NetworkName -> Text

toEncodedUrlPiece :: NetworkName -> Builder

toHeader :: NetworkName -> ByteString

toQueryParam :: NetworkName -> Text

data Network

LXD network.

Returned when querying GET /1.0/networks/<name>.

Constructors

Network

Fields

• networkName :: String
• networkConfig :: Map String String
• networkManaged :: Bool
• networkType :: String
• networkUsedBy :: [ContainerName]

Instances

Show Network

Methods

showsPrec :: Int -> Network -> ShowS

show :: Network -> String

showList :: [Network] -> ShowS

FromJSON Network

Methods

parseJSON :: Value -> Parser Network

parseJSONList :: Value -> Parser [Network]

data NetworkCreateRequest

LXD network create request.

Used when querying POST /1.0/networks.

Constructors

NetworkCreateRequest

Fields

• networkCreateRequestName :: NetworkName
• networkCreateRequestDescription :: String
• networkCreateRequestConfig :: Map String String

Instances

Show NetworkCreateRequest

Methods

showsPrec :: Int -> NetworkCreateRequest -> ShowS

show :: NetworkCreateRequest -> String

showList :: [NetworkCreateRequest] -> ShowS

ToJSON NetworkCreateRequest

Methods

toJSON :: NetworkCreateRequest -> Value

toEncoding :: NetworkCreateRequest -> Encoding

toJSONList :: [NetworkCreateRequest] -> Value

toEncodingList :: [NetworkCreateRequest] -> Encoding

newtype NetworkConfigRequest

LXD network config update request.

Used when querying PUT/PATCH /1.0/networks/<name>.

Constructors

NetworkConfigRequest

Fields

• networkConfigRequestConfig :: Map String String

Instances

Show NetworkConfigRequest

Methods

showsPrec :: Int -> NetworkConfigRequest -> ShowS

show :: NetworkConfigRequest -> String

showList :: [NetworkConfigRequest] -> ShowS

ToJSON NetworkConfigRequest

Methods

toJSON :: NetworkConfigRequest -> Value

toEncoding :: NetworkConfigRequest -> Encoding

toJSONList :: [NetworkConfigRequest] -> Value

toEncodingList :: [NetworkConfigRequest] -> Encoding

Profiles

newtype ProfileName

LXD profile name.

Returned by GET /1.0/profiles.

Constructors

ProfileName String

Instances

Eq ProfileName

Methods

(==) :: ProfileName -> ProfileName -> Bool

(/=) :: ProfileName -> ProfileName -> Bool

Show ProfileName

Methods

showsPrec :: Int -> ProfileName -> ShowS

show :: ProfileName -> String

showList :: [ProfileName] -> ShowS

IsString ProfileName

Methods

fromString :: String -> ProfileName

FromJSON ProfileName

Methods

parseJSON :: Value -> Parser ProfileName

parseJSONList :: Value -> Parser [ProfileName]

ToHttpApiData ProfileName

Methods

toUrlPiece :: ProfileName -> Text

toEncodedUrlPiece :: ProfileName -> Builder

toHeader :: ProfileName -> ByteString

toQueryParam :: ProfileName -> Text

data Profile

LXD profile.

Returned by GET /1.0/profiles/<name>.

Constructors

Profile

Fields

• profileName :: String
• profileDescription :: String
• profileConfig :: Map String String
• profileDevices :: Map String (Map String String)
• profileUsedBy :: [ContainerName]

Instances

Show Profile

Methods

showsPrec :: Int -> Profile -> ShowS

show :: Profile -> String

showList :: [Profile] -> ShowS

FromJSON Profile

Methods

parseJSON :: Value -> Parser Profile

parseJSONList :: Value -> Parser [Profile]

data ProfileCreateRequest

LXD profile create request.

Used when querying POST /1.0/profiles.

Constructors

ProfileCreateRequest

Fields

• profileCreateRequestName :: String
• profileCreateRequestDescription :: String
• profileCreateRequestConfig :: Map String String
• profileCreateRequestDevices :: Map String (Map String String)

Instances

Show ProfileCreateRequest

Methods

showsPrec :: Int -> ProfileCreateRequest -> ShowS

show :: ProfileCreateRequest -> String

showList :: [ProfileCreateRequest] -> ShowS

ToJSON ProfileCreateRequest

Methods

toJSON :: ProfileCreateRequest -> Value

toEncoding :: ProfileCreateRequest -> Encoding

toJSONList :: [ProfileCreateRequest] -> Value

toEncodingList :: [ProfileCreateRequest] -> Encoding

data ProfileConfigRequest

LXD profile config request.

Used when querying PUT/PATCH /1.0/profiles/<name>.

Constructors

ProfileConfigRequest

Fields

• profileConfigRequestConfig :: Maybe (Map String String)
• profileConfigRequestDescription :: Maybe String
• profileConfigRequestDevices :: Maybe (Map String (Map String String))

Instances

Show ProfileConfigRequest

Methods

showsPrec :: Int -> ProfileConfigRequest -> ShowS

show :: ProfileConfigRequest -> String

showList :: [ProfileConfigRequest] -> ShowS

ToJSON ProfileConfigRequest

Methods

toJSON :: ProfileConfigRequest -> Value

toEncoding :: ProfileConfigRequest -> Encoding

toJSONList :: [ProfileConfigRequest] -> Value

toEncodingList :: [ProfileConfigRequest] -> Encoding

Storage

newtype PoolName

LXD storage pool name.

Returned by GET /1.0/storage-pools.

Constructors

PoolName String

Instances

Eq PoolName

Methods

(==) :: PoolName -> PoolName -> Bool

(/=) :: PoolName -> PoolName -> Bool

Show PoolName

Methods

showsPrec :: Int -> PoolName -> ShowS

show :: PoolName -> String

showList :: [PoolName] -> ShowS

IsString PoolName

Methods

fromString :: String -> PoolName

FromJSON PoolName

Methods

parseJSON :: Value -> Parser PoolName

parseJSONList :: Value -> Parser [PoolName]

ToHttpApiData PoolName

Methods

toUrlPiece :: PoolName -> Text

toEncodedUrlPiece :: PoolName -> Builder

toHeader :: PoolName -> ByteString

toQueryParam :: PoolName -> Text

data Pool

LXD pool.

Returned by GET /1.0/storage-pools/<name>.

Constructors

Pool

Fields

• poolName :: String
• poolDescription :: String
• poolDriver :: String
• poolConfig :: Map String String
• poolUsedBy :: [ContainerName]

Instances

Show Pool

Methods

showsPrec :: Int -> Pool -> ShowS

show :: Pool -> String

showList :: [Pool] -> ShowS

FromJSON Pool

Methods

parseJSON :: Value -> Parser Pool

parseJSONList :: Value -> Parser [Pool]

data PoolCreateRequest

LXD pool create request.

Used when querying POST /1.0/storage-pools.

Constructors

PoolCreateRequest

Fields

• poolCreateRequestName :: String
• poolCreateRequestDriver :: String
• poolCreateRequestConfig :: Map String String

Instances

Show PoolCreateRequest

Methods

showsPrec :: Int -> PoolCreateRequest -> ShowS

show :: PoolCreateRequest -> String

showList :: [PoolCreateRequest] -> ShowS

ToJSON PoolCreateRequest

Methods

toJSON :: PoolCreateRequest -> Value

toEncoding :: PoolCreateRequest -> Encoding

toJSONList :: [PoolCreateRequest] -> Value

toEncodingList :: [PoolCreateRequest] -> Encoding

newtype PoolConfigRequest

LXD pool config request.

Used when querying PUT/PATCH /1.0/storage-pools/<name>.

Constructors

PoolConfigRequest

Fields

• poolConfigRequestConfig :: Map String String

Instances

Show PoolConfigRequest

Methods

showsPrec :: Int -> PoolConfigRequest -> ShowS

show :: PoolConfigRequest -> String

showList :: [PoolConfigRequest] -> ShowS

ToJSON PoolConfigRequest

Methods

toJSON :: PoolConfigRequest -> Value

toEncoding :: PoolConfigRequest -> Encoding

toJSONList :: [PoolConfigRequest] -> Value

toEncodingList :: [PoolConfigRequest] -> Encoding

Volumes

type VolumeType = String

Type of a volume.

data VolumeName

LXD volume name, and its type.

Returned by GET /1.0/storage-pools/<name>/volumes.

Constructors

VolumeName VolumeType String

Instances

FromJSON VolumeName

Methods

parseJSON :: Value -> Parser VolumeName

parseJSONList :: Value -> Parser [VolumeName]

ToHttpApiData VolumeName

Methods

toUrlPiece :: VolumeName -> Text

toEncodedUrlPiece :: VolumeName -> Builder

toHeader :: VolumeName -> ByteString

toQueryParam :: VolumeName -> Text

data Volume

LXD volume.

Returend by GET /1.0/storage-pools/<name>/volumes/<type>/<volume>.

Constructors

Volume

Fields

• volumeName :: String
• volumeType :: String
• volumeConfig :: Map String String
• volumeUsedBy :: [ContainerName]

Instances

Show Volume

Methods

showsPrec :: Int -> Volume -> ShowS

show :: Volume -> String

showList :: [Volume] -> ShowS

FromJSON Volume

Methods

parseJSON :: Value -> Parser Volume

parseJSONList :: Value -> Parser [Volume]

data VolumeCreateRequest

LXD volume create request.

Used when querying POST /1.0/storage-pools/<name>/volumes.

Constructors

VolumeCreateRequest

Fields

• volumeCreateRequestConfig :: Map String String
• volumeCreateRequestPool :: String
• volumeCreateRequestName :: String
• volumeCreateRequestType :: String

Instances

Show VolumeCreateRequest

Methods

showsPrec :: Int -> VolumeCreateRequest -> ShowS

show :: VolumeCreateRequest -> String

showList :: [VolumeCreateRequest] -> ShowS

ToJSON VolumeCreateRequest

Methods

toJSON :: VolumeCreateRequest -> Value

toEncoding :: VolumeCreateRequest -> Encoding

toJSONList :: [VolumeCreateRequest] -> Value

toEncodingList :: [VolumeCreateRequest] -> Encoding

newtype VolumeConfigRequest

LXD volume config request.

Returend by PUT/PATCH /1.0/storage-pools/<name>/volumes/<type>/<volume>.

Constructors

VolumeConfigRequest

Fields

• volumeConfigRequestConfig :: Map String String

Instances

Show VolumeConfigRequest

Methods

showsPrec :: Int -> VolumeConfigRequest -> ShowS

show :: VolumeConfigRequest -> String

showList :: [VolumeConfigRequest] -> ShowS

ToJSON VolumeConfigRequest

Methods

toJSON :: VolumeConfigRequest -> Value

toEncoding :: VolumeConfigRequest -> Encoding

toJSONList :: [VolumeConfigRequest] -> Value

toEncodingList :: [VolumeConfigRequest] -> Encoding

Operations

newtype OperationId

LXD operation identifier.

Constructors

OperationId String

Instances

Eq OperationId

Methods

(==) :: OperationId -> OperationId -> Bool

(/=) :: OperationId -> OperationId -> Bool

Show OperationId

Methods

showsPrec :: Int -> OperationId -> ShowS

show :: OperationId -> String

showList :: [OperationId] -> ShowS

IsString OperationId

Methods

fromString :: String -> OperationId

FromJSON OperationId

Methods

parseJSON :: Value -> Parser OperationId

parseJSONList :: Value -> Parser [OperationId]

ToHttpApiData OperationId

Methods

toUrlPiece :: OperationId -> Text

toEncodedUrlPiece :: OperationId -> Builder

toHeader :: OperationId -> ByteString

toQueryParam :: OperationId -> Text

type OperationStatus = String

LXD operation status.

newtype AllOperations

LXD list of all operations.

Constructors

AllOperations (Map OperationStatus [OperationId])

Instances

Show AllOperations

Methods

showsPrec :: Int -> AllOperations -> ShowS

show :: AllOperations -> String

showList :: [AllOperations] -> ShowS

FromJSON AllOperations

Methods

parseJSON :: Value -> Parser AllOperations

parseJSONList :: Value -> Parser [AllOperations]

data Operation

LXD operation.

Returned when querying GET /1.0/operations/<uuid>.

Constructors

Operation

Fields

• operationId :: String
• operationClass :: String
• operationCreatedAt :: String
• operationUpdatedAt :: String
• operationStatus :: OperationStatus
• operationStatusCode :: StatusCode
• operationMetadata :: Value
• operationMayCancel :: Bool
• operationErr :: String

Instances

Show Operation

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

FromJSON Operation

Methods

parseJSON :: Value -> Parser Operation

parseJSONList :: Value -> Parser [Operation]

newtype OperationProgress

Progress of an LXD operation.

You can try to decode operationMetadata if the operationStatusCode is SRunning to see of the operation contains progress information.

The embedded String value is in the format 87% (12.04 MB/s).

Constructors

OperationProgress String

Instances

Show OperationProgress

Methods

showsPrec :: Int -> OperationProgress -> ShowS

show :: OperationProgress -> String

showList :: [OperationProgress] -> ShowS

FromJSON OperationProgress

Methods

parseJSON :: Value -> Parser OperationProgress

parseJSONList :: Value -> Parser [OperationProgress]

Events

data EventType

Type of an LXD event from the /1.0/events handle.

Constructors

EventTypeLogging

EventTypeOperation

Instances

Eq EventType

Methods

(==) :: EventType -> EventType -> Bool

(/=) :: EventType -> EventType -> Bool

Show EventType

Methods

showsPrec :: Int -> EventType -> ShowS

show :: EventType -> String

showList :: [EventType] -> ShowS

FromJSON EventType

Methods

parseJSON :: Value -> Parser EventType

parseJSONList :: Value -> Parser [EventType]

ToHttpApiData EventType

Methods

toUrlPiece :: EventType -> Text

toEncodedUrlPiece :: EventType -> Builder

toHeader :: EventType -> ByteString

toQueryParam :: EventType -> Text

FromHttpApiData EventType

Methods

parseUrlPiece :: Text -> Either Text EventType

parseHeader :: ByteString -> Either Text EventType

parseQueryParam :: Text -> Either Text EventType

data Event

An event received from /1.0/events.

Constructors

Event

Fields

• eventTimestamp :: String
• eventType :: EventType
• eventMetadata :: EventMetadata

Instances

Show Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

FromJSON Event

Methods

parseJSON :: Value -> Parser Event

parseJSONList :: Value -> Parser [Event]

data EventMetadata

Metadata of an event.

Constructors

EventLoggingMetadata Value

EventOperationMetadata Operation

Instances

Show EventMetadata

Methods

showsPrec :: Int -> EventMetadata -> ShowS

show :: EventMetadata -> String

showList :: [EventMetadata] -> ShowS

Servant Helpers

data JsonOrBinary

Instances

Accept * JsonOrBinary

Methods

contentType :: Proxy JsonOrBinary ctype -> MediaType

contentTypes :: Proxy JsonOrBinary ctype -> NonEmpty MediaType

MimeUnrender * JsonOrBinary RawFileResponse

Methods

mimeUnrender :: Proxy JsonOrBinary RawFileResponse -> ByteString -> Either String a

mimeUnrenderWithType :: Proxy JsonOrBinary RawFileResponse -> MediaType -> ByteString -> Either String a