Safe Haskell	None
Language	Haskell2010

Network.LXD.Client.Types

Contents

Generic responses
- Background operations
API
Certificates
Containers
Images
Networks
Profiles
Storage
Volumes
Operations
Events
Servant Helpers

Description

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.

Synopsis

Generic responses

data GenericResponse op a Source #

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) Source #
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) Source #
Methods parseJSON :: Value -> Parser (GenericResponse op a) # parseJSONList :: Value -> Parser [GenericResponse op a] #

type Response a = GenericResponse String a Source #

LXD API synchronous repsonse object, without resulting operation.

type AsyncResponse a = GenericResponse OperationId (BackgroundOperation a) Source #

LXD API asynchronous response object, with resulting operation

data ResponseType Source #

The type of a generic response object.

Constructors

Sync
Async

Instances

Eq ResponseType Source #
Methods (==) :: ResponseType -> ResponseType -> Bool # (/=) :: ResponseType -> ResponseType -> Bool #
Show ResponseType Source #
Methods showsPrec :: Int -> ResponseType -> ShowS # show :: ResponseType -> String # showList :: [ResponseType] -> ShowS #
FromJSON ResponseType Source #
Methods parseJSON :: Value -> Parser ResponseType # parseJSONList :: Value -> Parser [ResponseType] #

data StatusCode Source #

Constructors

SCreated
SStopped
SRunning
SSuccess
SFailure
SCancelled
SOther Int

Instances

Eq StatusCode Source #
Methods (==) :: StatusCode -> StatusCode -> Bool # (/=) :: StatusCode -> StatusCode -> Bool #
Ord StatusCode Source #
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 Source #
Methods showsPrec :: Int -> StatusCode -> ShowS # show :: StatusCode -> String # showList :: [StatusCode] -> ShowS #
ToJSON StatusCode Source #
Methods toJSON :: StatusCode -> Value # toEncoding :: StatusCode -> Encoding # toJSONList :: [StatusCode] -> Value # toEncodingList :: [StatusCode] -> Encoding #
FromJSON StatusCode Source #
Methods parseJSON :: Value -> Parser StatusCode # parseJSONList :: Value -> Parser [StatusCode] #

Background operations

data BackgroundOperation m Source #

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) Source #
Methods parseJSON :: Value -> Parser (BackgroundOperation m) # parseJSONList :: Value -> Parser [BackgroundOperation m] #

API

data ApiConfig Source #

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 Source #
Methods showsPrec :: Int -> ApiConfig -> ShowS # show :: ApiConfig -> String # showList :: [ApiConfig] -> ShowS #
FromJSON ApiConfig Source #
Methods parseJSON :: Value -> Parser ApiConfig # parseJSONList :: Value -> Parser [ApiConfig] #

data ApiStatus Source #

Constructors

Development
Stable
Deprecated

Instances

Eq ApiStatus Source #
Methods (==) :: ApiStatus -> ApiStatus -> Bool # (/=) :: ApiStatus -> ApiStatus -> Bool #
Show ApiStatus Source #
Methods showsPrec :: Int -> ApiStatus -> ShowS # show :: ApiStatus -> String # showList :: [ApiStatus] -> ShowS #
FromJSON ApiStatus Source #
Methods parseJSON :: Value -> Parser ApiStatus # parseJSONList :: Value -> Parser [ApiStatus] #

data AuthStatus Source #

Constructors

Guest
Untrusted
Trusted

Instances

Eq AuthStatus Source #
Methods (==) :: AuthStatus -> AuthStatus -> Bool # (/=) :: AuthStatus -> AuthStatus -> Bool #
Show AuthStatus Source #
Methods showsPrec :: Int -> AuthStatus -> ShowS # show :: AuthStatus -> String # showList :: [AuthStatus] -> ShowS #
FromJSON AuthStatus Source #
Methods parseJSON :: Value -> Parser AuthStatus # parseJSONList :: Value -> Parser [AuthStatus] #

newtype ApiVersion Source #

LXD API version string, e.g. 1.0.

Constructors

ApiVersion String

Instances

Eq ApiVersion Source #
Methods (==) :: ApiVersion -> ApiVersion -> Bool # (/=) :: ApiVersion -> ApiVersion -> Bool #
Show ApiVersion Source #
Methods showsPrec :: Int -> ApiVersion -> ShowS # show :: ApiVersion -> String # showList :: [ApiVersion] -> ShowS #
FromJSON ApiVersion Source #
Methods parseJSON :: Value -> Parser ApiVersion # parseJSONList :: Value -> Parser [ApiVersion] #

data ApiExtension Source #

LXD API extension identifier.

Constructors

ExtPatch
ExtCertificateUpdate
ExtContainerExecRecording
ExtFileAppend
ExtFileDelete
ExtContainerEditMetadata
ExtImageCreateAliases
ExtNetwork
ExtStorage
ExtOther String

Instances

Eq ApiExtension Source #
Methods (==) :: ApiExtension -> ApiExtension -> Bool # (/=) :: ApiExtension -> ApiExtension -> Bool #
Ord ApiExtension Source #
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 Source #
Methods showsPrec :: Int -> ApiExtension -> ShowS # show :: ApiExtension -> String # showList :: [ApiExtension] -> ShowS #
ToJSON ApiExtension Source #
Methods toJSON :: ApiExtension -> Value # toEncoding :: ApiExtension -> Encoding # toJSONList :: [ApiExtension] -> Value # toEncodingList :: [ApiExtension] -> Encoding #
FromJSON ApiExtension Source #
Methods parseJSON :: Value -> Parser ApiExtension # parseJSONList :: Value -> Parser [ApiExtension] #

Certificates

newtype CertificateHash Source #

LXD trusted certificate hash.

Constructors

CertificateHash String

Instances

Eq CertificateHash Source #
Methods (==) :: CertificateHash -> CertificateHash -> Bool # (/=) :: CertificateHash -> CertificateHash -> Bool #
Show CertificateHash Source #
Methods showsPrec :: Int -> CertificateHash -> ShowS # show :: CertificateHash -> String # showList :: [CertificateHash] -> ShowS #
FromJSON CertificateHash Source #
Methods parseJSON :: Value -> Parser CertificateHash # parseJSONList :: Value -> Parser [CertificateHash] #

Containers

Querying information

newtype ContainerName Source #

LXD container name.

Constructors

ContainerName String

Instances

Eq ContainerName Source #
Methods (==) :: ContainerName -> ContainerName -> Bool # (/=) :: ContainerName -> ContainerName -> Bool #
Show ContainerName Source #
Methods showsPrec :: Int -> ContainerName -> ShowS # show :: ContainerName -> String # showList :: [ContainerName] -> ShowS #
IsString ContainerName Source #
Methods fromString :: String -> ContainerName #
ToJSON ContainerName Source #
Methods toJSON :: ContainerName -> Value # toEncoding :: ContainerName -> Encoding # toJSONList :: [ContainerName] -> Value # toEncodingList :: [ContainerName] -> Encoding #
FromJSON ContainerName Source #
Methods parseJSON :: Value -> Parser ContainerName # parseJSONList :: Value -> Parser [ContainerName] #
ToHttpApiData ContainerName Source #
Methods toUrlPiece :: ContainerName -> Text # toEncodedUrlPiece :: ContainerName -> Builder # toHeader :: ContainerName -> ByteString # toQueryParam :: ContainerName -> Text #

data Container Source #

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 Source #
Methods showsPrec :: Int -> Container -> ShowS # show :: Container -> String # showList :: [Container] -> ShowS #
FromJSON Container Source #
Methods parseJSON :: Value -> Parser Container # parseJSONList :: Value -> Parser [Container] #

Configuration

data ContainerPut Source #

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 Source #
Methods showsPrec :: Int -> ContainerPut -> ShowS # show :: ContainerPut -> String # showList :: [ContainerPut] -> ShowS #
ToJSON ContainerPut Source #
Methods toJSON :: ContainerPut -> Value # toEncoding :: ContainerPut -> Encoding # toJSONList :: [ContainerPut] -> Value # toEncodingList :: [ContainerPut] -> Encoding #

data ContainerPatch Source #

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 Source #
Methods showsPrec :: Int -> ContainerPatch -> ShowS # show :: ContainerPatch -> String # showList :: [ContainerPatch] -> ShowS #
ToJSON ContainerPatch Source #
Methods toJSON :: ContainerPatch -> Value # toEncoding :: ContainerPatch -> Encoding # toJSONList :: [ContainerPatch] -> Value # toEncodingList :: [ContainerPatch] -> Encoding #

newtype ContainerRename Source #

Used to rename a container to the given name.

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

Constructors

ContainerRename String

Instances

Show ContainerRename Source #
Methods showsPrec :: Int -> ContainerRename -> ShowS # show :: ContainerRename -> String # showList :: [ContainerRename] -> ShowS #
ToJSON ContainerRename Source #
Methods toJSON :: ContainerRename -> Value # toEncoding :: ContainerRename -> Encoding # toJSONList :: [ContainerRename] -> Value # toEncodingList :: [ContainerRename] -> Encoding #

State

data MemoryState Source #

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

Constructors

MemoryState
Fields memoryStateUsage :: Integer memoryStateUsagePeak :: Integer memoryStateSwapUsage :: Integer memoryStateSwapUsagePeak :: Integer

Instances

Show MemoryState Source #
Methods showsPrec :: Int -> MemoryState -> ShowS # show :: MemoryState -> String # showList :: [MemoryState] -> ShowS #
FromJSON MemoryState Source #
Methods parseJSON :: Value -> Parser MemoryState # parseJSONList :: Value -> Parser [MemoryState] #

data NetworkState Source #

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 Source #
Methods showsPrec :: Int -> NetworkState -> ShowS # show :: NetworkState -> String # showList :: [NetworkState] -> ShowS #
FromJSON NetworkState Source #
Methods parseJSON :: Value -> Parser NetworkState # parseJSONList :: Value -> Parser [NetworkState] #

data NetworkAddress Source #

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 Source #
Methods showsPrec :: Int -> NetworkAddress -> ShowS # show :: NetworkAddress -> String # showList :: [NetworkAddress] -> ShowS #
FromJSON NetworkAddress Source #
Methods parseJSON :: Value -> Parser NetworkAddress # parseJSONList :: Value -> Parser [NetworkAddress] #

data NetworkCounters Source #

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 Source #
Methods showsPrec :: Int -> NetworkCounters -> ShowS # show :: NetworkCounters -> String # showList :: [NetworkCounters] -> ShowS #
FromJSON NetworkCounters Source #
Methods parseJSON :: Value -> Parser NetworkCounters # parseJSONList :: Value -> Parser [NetworkCounters] #

data ContainerState Source #

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 Source #
Methods showsPrec :: Int -> ContainerState -> ShowS # show :: ContainerState -> String # showList :: [ContainerState] -> ShowS #
FromJSON ContainerState Source #
Methods parseJSON :: Value -> Parser ContainerState # parseJSONList :: Value -> Parser [ContainerState] #

data StateAction Source #

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

Constructors

Stop
Start
Restart
Freeze
Unfreeze

Instances

Eq StateAction Source #
Methods (==) :: StateAction -> StateAction -> Bool # (/=) :: StateAction -> StateAction -> Bool #
Show StateAction Source #
Methods showsPrec :: Int -> StateAction -> ShowS # show :: StateAction -> String # showList :: [StateAction] -> ShowS #
ToJSON StateAction Source #
Methods toJSON :: StateAction -> Value # toEncoding :: StateAction -> Encoding # toJSONList :: [StateAction] -> Value # toEncodingList :: [StateAction] -> Encoding #

data ContainerPutState Source #

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 Source #
Methods showsPrec :: Int -> ContainerPutState -> ShowS # show :: ContainerPutState -> String # showList :: [ContainerPutState] -> ShowS #
ToJSON ContainerPutState Source #
Methods toJSON :: ContainerPutState -> Value # toEncoding :: ContainerPutState -> Encoding # toJSONList :: [ContainerPutState] -> Value # toEncodingList :: [ContainerPutState] -> Encoding #

containerNewState :: StateAction -> Bool -> ContainerPutState Source #

Creating containers

data ContainerCreateRequest Source #

LXD create container request object.

Used when querying POST /1.0/containers.

Instances

Show ContainerCreateRequest Source #
Methods showsPrec :: Int -> ContainerCreateRequest -> ShowS # show :: ContainerCreateRequest -> String # showList :: [ContainerCreateRequest] -> ShowS #
ToJSON ContainerCreateRequest Source #
Methods toJSON :: ContainerCreateRequest -> Value # toEncoding :: ContainerCreateRequest -> Encoding # toJSONList :: [ContainerCreateRequest] -> Value # toEncodingList :: [ContainerCreateRequest] -> Encoding #

containerCreateRequest :: String -> ContainerSource -> ContainerCreateRequest Source #

Create a default ContainerCreateRequest.

data ContainerSource Source #

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 Source #
Methods showsPrec :: Int -> ContainerSource -> ShowS # show :: ContainerSource -> String # showList :: [ContainerSource] -> ShowS #
ToJSON ContainerSource Source #
Methods toJSON :: ContainerSource -> Value # toEncoding :: ContainerSource -> Encoding # toJSONList :: [ContainerSource] -> Value # toEncodingList :: [ContainerSource] -> Encoding #

Deleting containers

data ContainerDeleteRequest Source #

LXD delete container request object.

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

Constructors

ContainerDeleteRequest

Instances

ToJSON ContainerDeleteRequest Source #
Methods toJSON :: ContainerDeleteRequest -> Value # toEncoding :: ContainerDeleteRequest -> Encoding # toJSONList :: [ContainerDeleteRequest] -> Value # toEncodingList :: [ContainerDeleteRequest] -> Encoding #
Default ContainerDeleteRequest Source #
Methods def :: ContainerDeleteRequest #

Executing commands

data ExecParams Source #

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 Source #
Methods showsPrec :: Int -> ExecParams -> ShowS # show :: ExecParams -> String # showList :: [ExecParams] -> ShowS #

data ExecRequest params Source #

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) Source #
Methods showsPrec :: Int -> ExecRequest params -> ShowS # show :: ExecRequest params -> String # showList :: [ExecRequest params] -> ShowS #
ToJSON (ExecRequest ExecImmediate) Source #
Methods toJSON :: ExecRequest ExecImmediate -> Value # toEncoding :: ExecRequest ExecImmediate -> Encoding # toJSONList :: [ExecRequest ExecImmediate] -> Value # toEncodingList :: [ExecRequest ExecImmediate] -> Encoding #
ToJSON (ExecRequest ExecWebsocketInteractive) Source #
Methods toJSON :: ExecRequest ExecWebsocketInteractive -> Value # toEncoding :: ExecRequest ExecWebsocketInteractive -> Encoding # toJSONList :: [ExecRequest ExecWebsocketInteractive] -> Value # toEncodingList :: [ExecRequest ExecWebsocketInteractive] -> Encoding #
ToJSON (ExecRequest ExecWebsocketNonInteractive) Source #
Methods toJSON :: ExecRequest ExecWebsocketNonInteractive -> Value # toEncoding :: ExecRequest ExecWebsocketNonInteractive -> Encoding # toJSONList :: [ExecRequest ExecWebsocketNonInteractive] -> Value # toEncodingList :: [ExecRequest ExecWebsocketNonInteractive] -> Encoding #
Default (ExecRequest a) Source #
Methods def :: ExecRequest a #

type ExecResponseMetadataImmediate = Value Source #

Metadata of an immediate exec response.

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

newtype ExecResponseMetadataWebsocket fdset Source #

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) Source #
Methods showsPrec :: Int -> ExecResponseMetadataWebsocket fdset -> ShowS # show :: ExecResponseMetadataWebsocket fdset -> String # showList :: [ExecResponseMetadataWebsocket fdset] -> ShowS #
FromJSON (ExecResponseMetadataWebsocket FdAll) Source #
Methods parseJSON :: Value -> Parser (ExecResponseMetadataWebsocket FdAll) # parseJSONList :: Value -> Parser [ExecResponseMetadataWebsocket FdAll] #
FromJSON (ExecResponseMetadataWebsocket FdPty) Source #
Methods parseJSON :: Value -> Parser (ExecResponseMetadataWebsocket FdPty) # parseJSONList :: Value -> Parser [ExecResponseMetadataWebsocket FdPty] #

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

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 Source #

A secret used to connect to a websocket.

Constructors

Secret String

Instances

Eq Secret Source #
Methods (==) :: Secret -> Secret -> Bool # (/=) :: Secret -> Secret -> Bool #
Show Secret Source #
Methods showsPrec :: Int -> Secret -> ShowS # show :: Secret -> String # showList :: [Secret] -> ShowS #
FromJSON Secret Source #
Methods parseJSON :: Value -> Parser Secret # parseJSONList :: Value -> Parser [Secret] #

data FdSet Source #

A set of selected file descriptors.

Constructors

FdAll
FdPty

Instances

Show FdSet Source #
Methods showsPrec :: Int -> FdSet -> ShowS # show :: FdSet -> String # showList :: [FdSet] -> ShowS #

data Fds set where Source #

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) Source #
Methods showsPrec :: Int -> Fds set -> ShowS # show :: Fds set -> String # showList :: [Fds set] -> ShowS #
FromJSON (Fds FdAll) Source #
Methods parseJSON :: Value -> Parser (Fds FdAll) # parseJSONList :: Value -> Parser [Fds FdAll] #
FromJSON (Fds FdPty) Source #
Methods parseJSON :: Value -> Parser (Fds FdPty) # parseJSONList :: Value -> Parser [Fds FdPty] #

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

Type family converting an ExecParams to an FdSet.

Equations

ExecFds ExecWebsocketInteractive = FdPty
ExecFds ExecWebsocketNonInteractive = FdAll

Working with files

newtype Gid Source #

Group ID of a container file.

Constructors

Gid Int

Instances

Bounded Gid Source #
Methods minBound :: Gid # maxBound :: Gid #
Enum Gid Source #
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 Source #
Methods (==) :: Gid -> Gid -> Bool # (/=) :: Gid -> Gid -> Bool #
Integral Gid Source #
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 Source #
Methods (+) :: Gid -> Gid -> Gid # (-) :: Gid -> Gid -> Gid # (*) :: Gid -> Gid -> Gid # negate :: Gid -> Gid # abs :: Gid -> Gid # signum :: Gid -> Gid # fromInteger :: Integer -> Gid #
Ord Gid Source #
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 Source #
Methods readsPrec :: Int -> ReadS Gid # readList :: ReadS [Gid] # readPrec :: ReadPrec Gid # readListPrec :: ReadPrec [Gid] #
Real Gid Source #
Methods toRational :: Gid -> Rational #
Show Gid Source #
Methods showsPrec :: Int -> Gid -> ShowS # show :: Gid -> String # showList :: [Gid] -> ShowS #
ToHttpApiData Gid Source #
Methods toUrlPiece :: Gid -> Text # toEncodedUrlPiece :: Gid -> Builder # toHeader :: Gid -> ByteString # toQueryParam :: Gid -> Text #
FromHttpApiData Gid Source #
Methods parseUrlPiece :: Text -> Either Text Gid # parseHeader :: ByteString -> Either Text Gid # parseQueryParam :: Text -> Either Text Gid #

newtype Uid Source #

User ID of a container file.

Constructors

Uid Int

Instances

Bounded Uid Source #
Methods minBound :: Uid # maxBound :: Uid #
Enum Uid Source #
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 Source #
Methods (==) :: Uid -> Uid -> Bool # (/=) :: Uid -> Uid -> Bool #
Integral Uid Source #
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 Source #
Methods (+) :: Uid -> Uid -> Uid # (-) :: Uid -> Uid -> Uid # (*) :: Uid -> Uid -> Uid # negate :: Uid -> Uid # abs :: Uid -> Uid # signum :: Uid -> Uid # fromInteger :: Integer -> Uid #
Ord Uid Source #
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 Source #
Methods readsPrec :: Int -> ReadS Uid # readList :: ReadS [Uid] # readPrec :: ReadPrec Uid # readListPrec :: ReadPrec [Uid] #
Real Uid Source #
Methods toRational :: Uid -> Rational #
Show Uid Source #
Methods showsPrec :: Int -> Uid -> ShowS # show :: Uid -> String # showList :: [Uid] -> ShowS #
ToHttpApiData Uid Source #
Methods toUrlPiece :: Uid -> Text # toEncodedUrlPiece :: Uid -> Builder # toHeader :: Uid -> ByteString # toQueryParam :: Uid -> Text #
FromHttpApiData Uid Source #
Methods parseUrlPiece :: Text -> Either Text Uid # parseHeader :: ByteString -> Either Text Uid # parseQueryParam :: Text -> Either Text Uid #

newtype FileMode Source #

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

Constructors

FileMode String

Instances

Eq FileMode Source #
Methods (==) :: FileMode -> FileMode -> Bool # (/=) :: FileMode -> FileMode -> Bool #
Ord FileMode Source #
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 Source #
Methods readsPrec :: Int -> ReadS FileMode # readList :: ReadS [FileMode] # readPrec :: ReadPrec FileMode # readListPrec :: ReadPrec [FileMode] #
Show FileMode Source #
Methods showsPrec :: Int -> FileMode -> ShowS # show :: FileMode -> String # showList :: [FileMode] -> ShowS #
IsString FileMode Source #
Methods fromString :: String -> FileMode #
ToHttpApiData FileMode Source #
Methods toUrlPiece :: FileMode -> Text # toEncodedUrlPiece :: FileMode -> Builder # toHeader :: FileMode -> ByteString # toQueryParam :: FileMode -> Text #
FromHttpApiData FileMode Source #
Methods parseUrlPiece :: Text -> Either Text FileMode # parseHeader :: ByteString -> Either Text FileMode # parseQueryParam :: Text -> Either Text FileMode #

newtype FileType Source #

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

Constructors

FileType String

Instances

Eq FileType Source #
Methods (==) :: FileType -> FileType -> Bool # (/=) :: FileType -> FileType -> Bool #
Ord FileType Source #
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 Source #
Methods readsPrec :: Int -> ReadS FileType # readList :: ReadS [FileType] # readPrec :: ReadPrec FileType # readListPrec :: ReadPrec [FileType] #
Show FileType Source #
Methods showsPrec :: Int -> FileType -> ShowS # show :: FileType -> String # showList :: [FileType] -> ShowS #
IsString FileType Source #
Methods fromString :: String -> FileType #
ToHttpApiData FileType Source #
Methods toUrlPiece :: FileType -> Text # toEncodedUrlPiece :: FileType -> Builder # toHeader :: FileType -> ByteString # toQueryParam :: FileType -> Text #
FromHttpApiData FileType Source #
Methods parseUrlPiece :: Text -> Either Text FileType # parseHeader :: ByteString -> Either Text FileType # parseQueryParam :: Text -> Either Text FileType #

data RawFileResponse Source #

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 Source #
Methods showsPrec :: Int -> RawFileResponse -> ShowS # show :: RawFileResponse -> String # showList :: [RawFileResponse] -> ShowS #
MimeUnrender * JsonOrBinary RawFileResponse Source #
Methods mimeUnrender :: Proxy JsonOrBinary RawFileResponse -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy JsonOrBinary RawFileResponse -> MediaType -> ByteString -> Either String a #

rawFileResponseBody :: RawFileResponse -> ByteString Source #

Get the body of a RawFileResponse.

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

Construct a file response from a type and a ByteString.

data FileResponse Source #

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 Source #
Methods showsPrec :: Int -> FileResponse -> ShowS # show :: FileResponse -> String # showList :: [FileResponse] -> ShowS #
FromJSON FileResponse Source #
Methods parseJSON :: Value -> Parser FileResponse # parseJSONList :: Value -> Parser [FileResponse] #

data PathResponse Source #

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 Source #
Methods showsPrec :: Int -> PathResponse -> ShowS # show :: PathResponse -> String # showList :: [PathResponse] -> ShowS #

Referencing containers

newtype LocalContainer Source #

Reference to a local container, as used by ImageSource.

Constructors

LocalContainer ContainerName

Instances

Show LocalContainer Source #
Methods showsPrec :: Int -> LocalContainer -> ShowS # show :: LocalContainer -> String # showList :: [LocalContainer] -> ShowS #
IsString LocalContainer Source #
Methods fromString :: String -> LocalContainer #

Images

Querying information

newtype ImageId Source #

LXD image identifier.

Constructors

ImageId String

Instances

Eq ImageId Source #
Methods (==) :: ImageId -> ImageId -> Bool # (/=) :: ImageId -> ImageId -> Bool #
Show ImageId Source #
Methods showsPrec :: Int -> ImageId -> ShowS # show :: ImageId -> String # showList :: [ImageId] -> ShowS #
ToJSON ImageId Source #
Methods toJSON :: ImageId -> Value # toEncoding :: ImageId -> Encoding # toJSONList :: [ImageId] -> Value # toEncodingList :: [ImageId] -> Encoding #
FromJSON ImageId Source #
Methods parseJSON :: Value -> Parser ImageId # parseJSONList :: Value -> Parser [ImageId] #
ToHttpApiData ImageId Source #
Methods toUrlPiece :: ImageId -> Text # toEncodedUrlPiece :: ImageId -> Builder # toHeader :: ImageId -> ByteString # toQueryParam :: ImageId -> Text #

data Image Source #

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 Source #
Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
FromJSON Image Source #
Methods parseJSON :: Value -> Parser Image # parseJSONList :: Value -> Parser [Image] #

data ImageAlias Source #

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 Source #
Methods showsPrec :: Int -> ImageAlias -> ShowS # show :: ImageAlias -> String # showList :: [ImageAlias] -> ShowS #
ToJSON ImageAlias Source #
Methods toJSON :: ImageAlias -> Value # toEncoding :: ImageAlias -> Encoding # toJSONList :: [ImageAlias] -> Value # toEncodingList :: [ImageAlias] -> Encoding #
FromJSON ImageAlias Source #
Methods parseJSON :: Value -> Parser ImageAlias # parseJSONList :: Value -> Parser [ImageAlias] #

defaultImageAlias :: String -> ImageAlias Source #

Create a default ImageAlias, with empty description and target.

data ImageProperties Source #

Properties of an image.

Constructors

ImageProperties
Fields imagePropertiesArchitecture :: Maybe String imagePropertiesDescription :: Maybe String imagePropertiesOs :: Maybe String imagePropertiesRelease :: Maybe String

Instances

Show ImageProperties Source #
Methods showsPrec :: Int -> ImageProperties -> ShowS # show :: ImageProperties -> String # showList :: [ImageProperties] -> ShowS #
FromJSON ImageProperties Source #
Methods parseJSON :: Value -> Parser ImageProperties # parseJSONList :: Value -> Parser [ImageProperties] #

newtype ImageAliasName Source #

LXD alias name.

Returned when querying GET /1.0/images/aliases.

Constructors

ImageAliasName String

Instances

Eq ImageAliasName Source #
Methods (==) :: ImageAliasName -> ImageAliasName -> Bool # (/=) :: ImageAliasName -> ImageAliasName -> Bool #
Show ImageAliasName Source #
Methods showsPrec :: Int -> ImageAliasName -> ShowS # show :: ImageAliasName -> String # showList :: [ImageAliasName] -> ShowS #
IsString ImageAliasName Source #
Methods fromString :: String -> ImageAliasName #
ToJSON ImageAliasName Source #
Methods toJSON :: ImageAliasName -> Value # toEncoding :: ImageAliasName -> Encoding # toJSONList :: [ImageAliasName] -> Value # toEncodingList :: [ImageAliasName] -> Encoding #
FromJSON ImageAliasName Source #
Methods parseJSON :: Value -> Parser ImageAliasName # parseJSONList :: Value -> Parser [ImageAliasName] #
ToHttpApiData ImageAliasName Source #
Methods toUrlPiece :: ImageAliasName -> Text # toEncodedUrlPiece :: ImageAliasName -> Builder # toHeader :: ImageAliasName -> ByteString # toQueryParam :: ImageAliasName -> Text #

Creating and publishing new images

data ImageCreateRequest Source #

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 Source #
Methods showsPrec :: Int -> ImageCreateRequest -> ShowS # show :: ImageCreateRequest -> String # showList :: [ImageCreateRequest] -> ShowS #
ToJSON ImageCreateRequest Source #
Methods toJSON :: ImageCreateRequest -> Value # toEncoding :: ImageCreateRequest -> Encoding # toJSONList :: [ImageCreateRequest] -> Value # toEncodingList :: [ImageCreateRequest] -> Encoding #

imageCreateRequest :: ImageSource -> ImageCreateRequest Source #

Construct a new default ImageCreateRequest.

data ImageSource Source #

A generic image source, used by ImageCreateRequest.

Constructors

ImageSourceRemoteImage RemoteImage
ImageSourceLocalContainer LocalContainer

Instances

Show ImageSource Source #
Methods showsPrec :: Int -> ImageSource -> ShowS # show :: ImageSource -> String # showList :: [ImageSource] -> ShowS #
ToJSON ImageSource Source #
Methods toJSON :: ImageSource -> Value # toEncoding :: ImageSource -> Encoding # toJSONList :: [ImageSource] -> Value # toEncodingList :: [ImageSource] -> Encoding #

Deleting images

data ImageDeleteRequest Source #

LXD image delete request object.

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

Constructors

ImageDeleteRequest

Instances

ToJSON ImageDeleteRequest Source #
Methods toJSON :: ImageDeleteRequest -> Value # toEncoding :: ImageDeleteRequest -> Encoding # toJSONList :: [ImageDeleteRequest] -> Value # toEncodingList :: [ImageDeleteRequest] -> Encoding #
Default ImageDeleteRequest Source #
Methods def :: ImageDeleteRequest #

Referencing images

newtype LocalImageByAlias Source #

Source for a local image, specified by its alias.

Constructors

LocalImageByAlias ImageAliasName

Instances

Show LocalImageByAlias Source #
Methods showsPrec :: Int -> LocalImageByAlias -> ShowS # show :: LocalImageByAlias -> String # showList :: [LocalImageByAlias] -> ShowS #
IsString LocalImageByAlias Source #
Methods fromString :: String -> LocalImageByAlias #

newtype LocalImageByFingerprint Source #

Source for a local image, specified by its fingerprint

Constructors

LocalImageByFingerprint ImageId

Instances

Show LocalImageByFingerprint Source #
Methods showsPrec :: Int -> LocalImageByFingerprint -> ShowS # show :: LocalImageByFingerprint -> String # showList :: [LocalImageByFingerprint] -> ShowS #

data RemoteImage Source #

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 Source #
Methods showsPrec :: Int -> RemoteImage -> ShowS # show :: RemoteImage -> String # showList :: [RemoteImage] -> ShowS #

remoteImage :: String -> ImageAliasName -> RemoteImage Source #

Create a remote image reference form a public remote.

remoteImageId :: String -> ImageId -> RemoteImage Source #

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

Networks

newtype NetworkName Source #

LXD network name.

Constructors

NetworkName String

Instances

Eq NetworkName Source #
Methods (==) :: NetworkName -> NetworkName -> Bool # (/=) :: NetworkName -> NetworkName -> Bool #
Show NetworkName Source #
Methods showsPrec :: Int -> NetworkName -> ShowS # show :: NetworkName -> String # showList :: [NetworkName] -> ShowS #
IsString NetworkName Source #
Methods fromString :: String -> NetworkName #
ToJSON NetworkName Source #
Methods toJSON :: NetworkName -> Value # toEncoding :: NetworkName -> Encoding # toJSONList :: [NetworkName] -> Value # toEncodingList :: [NetworkName] -> Encoding #
FromJSON NetworkName Source #
Methods parseJSON :: Value -> Parser NetworkName # parseJSONList :: Value -> Parser [NetworkName] #
ToHttpApiData NetworkName Source #
Methods toUrlPiece :: NetworkName -> Text # toEncodedUrlPiece :: NetworkName -> Builder # toHeader :: NetworkName -> ByteString # toQueryParam :: NetworkName -> Text #

data Network Source #

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 Source #
Methods showsPrec :: Int -> Network -> ShowS # show :: Network -> String # showList :: [Network] -> ShowS #
FromJSON Network Source #
Methods parseJSON :: Value -> Parser Network # parseJSONList :: Value -> Parser [Network] #

data NetworkCreateRequest Source #

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 Source #
Methods showsPrec :: Int -> NetworkCreateRequest -> ShowS # show :: NetworkCreateRequest -> String # showList :: [NetworkCreateRequest] -> ShowS #
ToJSON NetworkCreateRequest Source #
Methods toJSON :: NetworkCreateRequest -> Value # toEncoding :: NetworkCreateRequest -> Encoding # toJSONList :: [NetworkCreateRequest] -> Value # toEncodingList :: [NetworkCreateRequest] -> Encoding #

newtype NetworkConfigRequest Source #

LXD network config update request.

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

Constructors

NetworkConfigRequest
Fields networkConfigRequestConfig :: Map String String

Instances

Show NetworkConfigRequest Source #
Methods showsPrec :: Int -> NetworkConfigRequest -> ShowS # show :: NetworkConfigRequest -> String # showList :: [NetworkConfigRequest] -> ShowS #
ToJSON NetworkConfigRequest Source #
Methods toJSON :: NetworkConfigRequest -> Value # toEncoding :: NetworkConfigRequest -> Encoding # toJSONList :: [NetworkConfigRequest] -> Value # toEncodingList :: [NetworkConfigRequest] -> Encoding #

Profiles

newtype ProfileName Source #

LXD profile name.

Returned by GET /1.0/profiles.

Constructors

ProfileName String

Instances

Eq ProfileName Source #
Methods (==) :: ProfileName -> ProfileName -> Bool # (/=) :: ProfileName -> ProfileName -> Bool #
Show ProfileName Source #
Methods showsPrec :: Int -> ProfileName -> ShowS # show :: ProfileName -> String # showList :: [ProfileName] -> ShowS #
IsString ProfileName Source #
Methods fromString :: String -> ProfileName #
FromJSON ProfileName Source #
Methods parseJSON :: Value -> Parser ProfileName # parseJSONList :: Value -> Parser [ProfileName] #
ToHttpApiData ProfileName Source #
Methods toUrlPiece :: ProfileName -> Text # toEncodedUrlPiece :: ProfileName -> Builder # toHeader :: ProfileName -> ByteString # toQueryParam :: ProfileName -> Text #

data Profile Source #

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 Source #
Methods showsPrec :: Int -> Profile -> ShowS # show :: Profile -> String # showList :: [Profile] -> ShowS #
FromJSON Profile Source #
Methods parseJSON :: Value -> Parser Profile # parseJSONList :: Value -> Parser [Profile] #

data ProfileCreateRequest Source #

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 Source #
Methods showsPrec :: Int -> ProfileCreateRequest -> ShowS # show :: ProfileCreateRequest -> String # showList :: [ProfileCreateRequest] -> ShowS #
ToJSON ProfileCreateRequest Source #
Methods toJSON :: ProfileCreateRequest -> Value # toEncoding :: ProfileCreateRequest -> Encoding # toJSONList :: [ProfileCreateRequest] -> Value # toEncodingList :: [ProfileCreateRequest] -> Encoding #

data ProfileConfigRequest Source #

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 Source #
Methods showsPrec :: Int -> ProfileConfigRequest -> ShowS # show :: ProfileConfigRequest -> String # showList :: [ProfileConfigRequest] -> ShowS #
ToJSON ProfileConfigRequest Source #
Methods toJSON :: ProfileConfigRequest -> Value # toEncoding :: ProfileConfigRequest -> Encoding # toJSONList :: [ProfileConfigRequest] -> Value # toEncodingList :: [ProfileConfigRequest] -> Encoding #

Storage

newtype PoolName Source #

LXD storage pool name.

Returned by GET /1.0/storage-pools.

Constructors

PoolName String

Instances

Eq PoolName Source #
Methods (==) :: PoolName -> PoolName -> Bool # (/=) :: PoolName -> PoolName -> Bool #
Show PoolName Source #
Methods showsPrec :: Int -> PoolName -> ShowS # show :: PoolName -> String # showList :: [PoolName] -> ShowS #
IsString PoolName Source #
Methods fromString :: String -> PoolName #
FromJSON PoolName Source #
Methods parseJSON :: Value -> Parser PoolName # parseJSONList :: Value -> Parser [PoolName] #
ToHttpApiData PoolName Source #
Methods toUrlPiece :: PoolName -> Text # toEncodedUrlPiece :: PoolName -> Builder # toHeader :: PoolName -> ByteString # toQueryParam :: PoolName -> Text #

data Pool Source #

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 Source #
Methods showsPrec :: Int -> Pool -> ShowS # show :: Pool -> String # showList :: [Pool] -> ShowS #
FromJSON Pool Source #
Methods parseJSON :: Value -> Parser Pool # parseJSONList :: Value -> Parser [Pool] #

data PoolCreateRequest Source #

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 Source #
Methods showsPrec :: Int -> PoolCreateRequest -> ShowS # show :: PoolCreateRequest -> String # showList :: [PoolCreateRequest] -> ShowS #
ToJSON PoolCreateRequest Source #
Methods toJSON :: PoolCreateRequest -> Value # toEncoding :: PoolCreateRequest -> Encoding # toJSONList :: [PoolCreateRequest] -> Value # toEncodingList :: [PoolCreateRequest] -> Encoding #

newtype PoolConfigRequest Source #

LXD pool config request.

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

Constructors

PoolConfigRequest
Fields poolConfigRequestConfig :: Map String String

Instances

Show PoolConfigRequest Source #
Methods showsPrec :: Int -> PoolConfigRequest -> ShowS # show :: PoolConfigRequest -> String # showList :: [PoolConfigRequest] -> ShowS #
ToJSON PoolConfigRequest Source #
Methods toJSON :: PoolConfigRequest -> Value # toEncoding :: PoolConfigRequest -> Encoding # toJSONList :: [PoolConfigRequest] -> Value # toEncodingList :: [PoolConfigRequest] -> Encoding #

Volumes

type VolumeType = String Source #

Type of a volume.

data VolumeName Source #

LXD volume name, and its type.

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

Constructors

VolumeName VolumeType String

Instances

FromJSON VolumeName Source #
Methods parseJSON :: Value -> Parser VolumeName # parseJSONList :: Value -> Parser [VolumeName] #
ToHttpApiData VolumeName Source #
Methods toUrlPiece :: VolumeName -> Text # toEncodedUrlPiece :: VolumeName -> Builder # toHeader :: VolumeName -> ByteString # toQueryParam :: VolumeName -> Text #

data Volume Source #

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 Source #
Methods showsPrec :: Int -> Volume -> ShowS # show :: Volume -> String # showList :: [Volume] -> ShowS #
FromJSON Volume Source #
Methods parseJSON :: Value -> Parser Volume # parseJSONList :: Value -> Parser [Volume] #

data VolumeCreateRequest Source #

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 Source #
Methods showsPrec :: Int -> VolumeCreateRequest -> ShowS # show :: VolumeCreateRequest -> String # showList :: [VolumeCreateRequest] -> ShowS #
ToJSON VolumeCreateRequest Source #
Methods toJSON :: VolumeCreateRequest -> Value # toEncoding :: VolumeCreateRequest -> Encoding # toJSONList :: [VolumeCreateRequest] -> Value # toEncodingList :: [VolumeCreateRequest] -> Encoding #

newtype VolumeConfigRequest Source #

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 Source #
Methods showsPrec :: Int -> VolumeConfigRequest -> ShowS # show :: VolumeConfigRequest -> String # showList :: [VolumeConfigRequest] -> ShowS #
ToJSON VolumeConfigRequest Source #
Methods toJSON :: VolumeConfigRequest -> Value # toEncoding :: VolumeConfigRequest -> Encoding # toJSONList :: [VolumeConfigRequest] -> Value # toEncodingList :: [VolumeConfigRequest] -> Encoding #

Operations

newtype OperationId Source #

LXD operation identifier.

Constructors

OperationId String

Instances

Eq OperationId Source #
Methods (==) :: OperationId -> OperationId -> Bool # (/=) :: OperationId -> OperationId -> Bool #
Show OperationId Source #
Methods showsPrec :: Int -> OperationId -> ShowS # show :: OperationId -> String # showList :: [OperationId] -> ShowS #
IsString OperationId Source #
Methods fromString :: String -> OperationId #
FromJSON OperationId Source #
Methods parseJSON :: Value -> Parser OperationId # parseJSONList :: Value -> Parser [OperationId] #
ToHttpApiData OperationId Source #
Methods toUrlPiece :: OperationId -> Text # toEncodedUrlPiece :: OperationId -> Builder # toHeader :: OperationId -> ByteString # toQueryParam :: OperationId -> Text #

type OperationStatus = String Source #

LXD operation status.

newtype AllOperations Source #

LXD list of all operations.

Constructors

AllOperations (Map OperationStatus [OperationId])

Instances

Show AllOperations Source #
Methods showsPrec :: Int -> AllOperations -> ShowS # show :: AllOperations -> String # showList :: [AllOperations] -> ShowS #
FromJSON AllOperations Source #
Methods parseJSON :: Value -> Parser AllOperations # parseJSONList :: Value -> Parser [AllOperations] #

data Operation Source #

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 Source #
Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #
FromJSON Operation Source #
Methods parseJSON :: Value -> Parser Operation # parseJSONList :: Value -> Parser [Operation] #

newtype OperationProgress Source #

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 Source #
Methods showsPrec :: Int -> OperationProgress -> ShowS # show :: OperationProgress -> String # showList :: [OperationProgress] -> ShowS #
FromJSON OperationProgress Source #
Methods parseJSON :: Value -> Parser OperationProgress # parseJSONList :: Value -> Parser [OperationProgress] #

Events

data EventType Source #

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

Constructors

EventTypeLogging
EventTypeOperation

Instances

Eq EventType Source #
Methods (==) :: EventType -> EventType -> Bool # (/=) :: EventType -> EventType -> Bool #
Show EventType Source #
Methods showsPrec :: Int -> EventType -> ShowS # show :: EventType -> String # showList :: [EventType] -> ShowS #
FromJSON EventType Source #
Methods parseJSON :: Value -> Parser EventType # parseJSONList :: Value -> Parser [EventType] #
ToHttpApiData EventType Source #
Methods toUrlPiece :: EventType -> Text # toEncodedUrlPiece :: EventType -> Builder # toHeader :: EventType -> ByteString # toQueryParam :: EventType -> Text #
FromHttpApiData EventType Source #
Methods parseUrlPiece :: Text -> Either Text EventType # parseHeader :: ByteString -> Either Text EventType # parseQueryParam :: Text -> Either Text EventType #

data Event Source #

An event received from /1.0/events.

Constructors

Event
Fields eventTimestamp :: String eventType :: EventType eventMetadata :: EventMetadata

Instances

Show Event Source #
Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
FromJSON Event Source #
Methods parseJSON :: Value -> Parser Event # parseJSONList :: Value -> Parser [Event] #

data EventMetadata Source #

Metadata of an event.

Constructors

EventLoggingMetadata Value
EventOperationMetadata Operation

Instances

Show EventMetadata Source #
Methods showsPrec :: Int -> EventMetadata -> ShowS # show :: EventMetadata -> String # showList :: [EventMetadata] -> ShowS #

Servant Helpers

data JsonOrBinary Source #

Instances

Accept * JsonOrBinary Source #
Methods contentType :: Proxy JsonOrBinary ctype -> MediaType # contentTypes :: Proxy JsonOrBinary ctype -> NonEmpty MediaType #
MimeUnrender * JsonOrBinary RawFileResponse Source #
Methods mimeUnrender :: Proxy JsonOrBinary RawFileResponse -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy JsonOrBinary RawFileResponse -> MediaType -> ByteString -> Either String a #

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