Network.LXD.Client.API

Contents

• API
  • Information
  • Containers
    • Querying informaiton
    • Configuration
    • State
    • Executing commands
    • Working with files
  • Images
  • Networks
  • Profiles
  • Storage
• Volumes
  • Operations
  • WebSocket communciations
• Helpers

Description

Synopsis

• data FailureResponse = FailureResponse Request (Response ByteString)
• supportedVersions :: ClientM (Response [ApiVersion])
• apiConfig :: ClientM (Response ApiConfig)
• trustedCertificates :: ClientM (Response [CertificateHash])
• containerNames :: ClientM (Response [ContainerName])
• containerCreate :: ContainerCreateRequest -> ClientM (AsyncResponse Value)
• container :: ContainerName -> ClientM (Response Container)
• containerDelete :: ContainerName -> ContainerDeleteRequest -> ClientM (AsyncResponse Value)
• containerPut :: ContainerName -> ContainerPut -> ClientM (AsyncResponse Value)
• containerPatch :: ContainerName -> ContainerPatch -> ClientM (Response Value)
• containerRename :: ContainerName -> ContainerRename -> ClientM (AsyncResponse Value)
• containerState :: ContainerName -> ClientM (Response ContainerState)
• containerPutState :: ContainerName -> ContainerPutState -> ClientM (AsyncResponse Value)
• containerExecImmediate :: ExecClient ExecImmediate
• containerExecWebsocketInteractive :: ExecClient ExecWebsocketInteractive
• containerExecWebsocketNonInteractive :: ExecClient ExecWebsocketNonInteractive
• data WriteMode
  • = ModeOverwrite
  • | ModeAppend
• containerGetPath :: ContainerName -> FilePath -> ClientM PathResponse
• containerPostPath :: ContainerName -> FilePath -> Maybe Uid -> Maybe Gid -> Maybe FileMode -> FileType -> Maybe WriteMode -> ByteString -> ClientM (Response Value)
• containerDeletePath :: ContainerName -> FilePath -> ClientM (Response Value)
• imageIds :: ClientM (Response [ImageId])
• imageCreate :: ImageCreateRequest -> ClientM (AsyncResponse Value)
• imageAliases :: ClientM (Response [ImageAliasName])
• imageAlias :: ImageAliasName -> ClientM (Response ImageAlias)
• image :: ImageId -> ClientM (Response Image)
• imageDelete :: ImageId -> ImageDeleteRequest -> ClientM (AsyncResponse Value)
• networkList :: ClientM (Response [NetworkName])
• networkCreate :: NetworkCreateRequest -> ClientM (Response Value)
• network :: NetworkName -> ClientM (Response Network)
• networkPut :: NetworkName -> NetworkConfigRequest -> ClientM (Response Value)
• networkPatch :: NetworkName -> NetworkConfigRequest -> ClientM (Response Value)
• networkDelete :: NetworkName -> ClientM (Response Value)
• profileList :: ClientM (Response [ProfileName])
• profileCreate :: ProfileCreateRequest -> ClientM (Response Value)
• profile :: ProfileName -> ClientM (Response Profile)
• profilePut :: ProfileName -> ProfileConfigRequest -> ClientM (Response Value)
• profilePatch :: ProfileName -> ProfileConfigRequest -> ClientM (Response Value)
• profileDelete :: ProfileName -> ClientM (Response Value)
• poolList :: ClientM (Response [PoolName])
• poolCreate :: PoolCreateRequest -> ClientM (Response Value)
• pool :: PoolName -> ClientM (Response Pool)
• poolPut :: PoolName -> PoolConfigRequest -> ClientM (Response Value)
• poolPatch :: PoolName -> PoolConfigRequest -> ClientM (Response Value)
• poolDelete :: PoolName -> ClientM (Response Value)
• volumeList :: PoolName -> ClientM (Response [VolumeName])
• volumeCreate :: PoolName -> VolumeCreateRequest -> ClientM (Response Value)
• volume :: PoolName -> VolumeName -> ClientM (Response Volume)
• volumePut :: PoolName -> VolumeName -> VolumeConfigRequest -> ClientM (Response Value)
• volumePatch :: PoolName -> VolumeName -> VolumeConfigRequest -> ClientM (Response Value)
• volumeDelete :: PoolName -> VolumeName -> ClientM (Response Value)
• operationIds :: ClientM (Response AllOperations)
• operation :: OperationId -> ClientM (Response Operation)
• operationCancel :: OperationId -> ClientM (Response Value)
• operationWait :: OperationId -> ClientM (Response Operation)
• operationWebSocket :: OperationId -> Secret -> String
• readAllWebSocket :: (ByteString -> IO ()) -> ClientApp ()
• writeAllWebSocket :: MVar (Maybe ByteString) -> ClientApp ()
• type ExecClient a = ContainerName -> ExecRequest a -> ClientM (AsyncResponse (ExecResponseMetadata a))

API

Information

Containers

Querying informaiton

Configuration

State

Executing commands

Working with files

Images

Networks

Profiles

Storage

Volumes

Operations

WebSocket communciations

Helpers