func GetContainerStats(name: string) ContainerStats
func UpdateContainer() NotImplemented
func SearchImage(name: string, limit: int) ImageSearch
func CreateFromContainer() NotImplemented
func GetContainer(name: string) ListContainerData
func ListContainerChanges(name: string) map[string]
func RenameContainer() NotImplemented
func WaitContainer(name: string) int
func TagImage(name: string, tagged: string) string
func ListContainers() ListContainerData
func InspectContainer(name: string) string
func StartContainer() NotImplemented
func StopContainer(name: string, timeout: int) string
func BuildImage() NotImplemented
func PushImage(name: string, tag: string, tlsverify: bool) string
func GetContainerLogs(name: string) []string
func ExportContainer(name: string, path: string) string
func RestartContainer(name: string, timeout: int) string
func PauseContainer(name: string) string
func HistoryImage(name: string) ImageHistory
func PullImage(name: string) string
func ListContainerProcesses(name: string, opts: []string) []string
func DeleteUnusedImages() []string
func KillContainer(name: string, signal: int) string
func DeleteStoppedContainers() []string
func ResizeContainerTty() NotImplemented
func ImportImage(source: string, reference: string, message: string, changes: []string) string
func CreateImage() NotImplemented
func ExportImage(name: string, destination: string, compress: bool) string
func CreateContainer() NotImplemented
func RemoveContainer(name: string, force: bool) string
func InspectImage(name: string) string
func RemoveImage(name: string, force: bool) string
func UnpauseContainer(name: string) string
func AttachToContainer() NotImplemented type ContainerMount
func GetContainerStats(name: string) ContainerStats
GetContainerStats takes the name or ID of a container and returns a single ContainerStats structure which contains attributes like memory and cpu usage. If the container cannot be found, a ContainerNotFound error will be returned
func UpdateContainer() NotImplemented
This method has not be implemented yet.
func SearchImage(name: string, limit: int) ImageSearch
SearchImage takes the string of an image name and a limit of searches from each registries to be returned. SearchImage will then use a glob-like match to find the image you are searching for. The images are returned in an array of ImageSearch structures which contain information about the image as well as its fully-qualified name.
func CreateFromContainer() NotImplemented
This method is not implemented.
func Ping() StringResponse
Ping provides a response for developers to ensure their varlink setup is working.
func GetContainer(name: string) ListContainerData
GetContainer takes a name or ID of a container and returns single ListContainerData structure. A ContainerNotFound error will be returned if the container cannot be found.
func ListContainerChanges(name: string) map[string]
ListContainerChanges takes a name or ID of a container and returns changes between the container and its base image. The return values are expressed as string maps where a path -> the change. If the container cannot be found, a ContainerNotFound error will be returned.
func RenameContainer() NotImplemented
This method has not be implemented yet.
WaitContainer takes the name of ID of a container and waits until the container stops. Upon stopping, the return code of the container is returned. If the container container cannot be found by ID or name, a ContainerNotFound error is returned.
TagImage takes the name or ID of an image in local storage as well as the desired tag name. If the image cannot be found, an ImageNotFound error will be returned; otherwise, the ID of the image is returned on success.
func ListContainers() ListContainerData
ListContainers returns a list of containers in no particular order. There are returned as an array of ListContainerData structs
InspectContainer data takes a name or ID of a container returns the inspection data in string format. You can then serialize the string into JSON. A ContainerNotFound error will be returned if the container cannot be found.
func StartContainer() NotImplemented
This method has not be implemented yet.
StopContainer stops a container given a timeout. It takes the name or ID of a container as well as a timeout value. The timeout value the time before a forceable stop to the container is applied. It returns the container ID once stopped. If the container cannot be found, a ContainerNotFound error will be returned instead.
func BuildImage() NotImplemented
This function is not implemented yet.
PushImage takes three input arguments: the name or ID of an image, the fully-qualified destination name of the image, and a boolean as to whether tls-verify should be used. It will return an ImageNotFound error if the image cannot be found in local storage; otherwise the ID of the image will be returned on success.
GetContainerLogs takes a name or ID of a container and returns the logs of that container. If the container cannot be found, a ContainerNotFound error will be returned. The container logs are returned as an array of strings. GetContainerLogs will honor the streaming capability of varlink if the client invokes it.
ExportContainer creates an image from a container. It takes the name or ID of a container and a path representing the target tarfile. If the container cannot be found, a ContainerNotFound error will be returned. The return value is the written tarfile.
RestartContainer will restart a running container given a container name or ID and timeout value. The timeout value is the time before a forceable stop is used to stop the container. If the container cannot be found by name or ID, a ContainerNotFound error will be returned; otherwise, the ID of the container will be returned.
PauseContainer takes the name or ID of container and pauses it. If the container cannot be found, a ContainerNotFound error will be returned; otherwise the ID of the container is returned.
func HistoryImage(name: string) ImageHistory
HistoryImage takes the name or ID of an image and returns information about its history and layers. The returned history is in the form of an array of ImageHistory structures. If the image cannot be found, an ImageNotFound error is returned.
PullImage pulls an image from a repository to local storage. After the pull is successful, the ID of the image is returned.
func GetVersion() Version
GetVersion returns a Version structure describing the libpod setup on their system.
ListContainerProcesses takes a name or ID of a container and returns the processes running inside the container as array of strings. It will accept an array of string arguements that represent ps options. If the container cannot be found, a ContainerNotFound error will be returned.
func ListImages() ImageInList
ListImages returns an array of ImageInList structures which provide basic information about an image currenly in storage.
func DeleteUnusedImages() []string
DeleteUnusedImages deletes any images not associated with a container. The IDs of the deleted images are returned in a string array.
KillContainer takes the name or ID of a container as well as a signal to be applied to the container. Once the container has been killed, the container's ID is returned. If the container cannot be found, a ContainerNotFound error is returned.
func DeleteStoppedContainers() []string
DeleteStoppedContainers will delete all containers that are not running. It will return a list the deleted container IDs.
func ResizeContainerTty() NotImplemented
This method has not be implemented yet.
ImportImage imports an image from a source (like tarball) into local storage. The image can have additional descriptions added to it using the message and changes options.
func CreateImage() NotImplemented
This function is not implemented yet.
ExportImage takes the name or ID of an image and exports it to a destination like a tarball. There is also a booleon option to force compression. Upon completion, the ID of the image is returned. If the image cannot be found in local storage, an ImageNotFound error will be returned.
func CreateContainer() NotImplemented
This method has not been implemented yet.
RemoveContainer takes requires the name or ID of container as well a boolean representing whether a running container can be stopped and removed. Upon sucessful removal of the container, its ID is returned. If the container cannot be found by name or ID, an ContainerNotFound error will be returned.
InspectImage takes the name or ID of an image and returns a string respresentation of data associated with the mage. You must serialize the string into JSON to use it further. An ImageNotFound error will be returned if the image cannot be found.
RemoveImage takes the name or ID of an image as well as a booleon that determines if containers using that image should be deleted. If the image cannot be found, an [ImageNotFound](#ImageNotFound error will be returned. The D of the removed image is returned when complete.
UnpauseContainer takes the name or ID of container and unpauses a paused container. If the container cannot be found, a ContainerNotFound error will be returned; otherwise the ID of the container is returned.
func AttachToContainer() NotImplemented
This method has not be implemented yet.
ContainerMount describes the struct for mounts in a container
destination string
type string
source string
options []string
ContainerPortMappings describes the struct for portmappings in an existing container
host_port string
host_ip string
protocol string
container_port string
ContainerNamespace describes the namespace structure for an existing container
user string
uts string
pidns string
pid string
cgroup string
net string
mnt string
ipc string
Version is the structure returned by GetVersion
version string
go_version string
git_commit string
built int
os_arch string
comment string
ImageInList describes the structure that is returned in ListImages.
id string
parentId string
repoTags []string
repoDigests []string
created string
size int
virtualSize int
containers int
labels map[string]
ImageHistory describes the returned structure from ImageHistory.
id string
created string
createdBy string
tags []string
size int
comment string
ImageSearch is the returned structure for SearchImage. It is returned in arrary form.
description string
is_official bool
is_automated bool
name string
star_count int
message string
ListContainer is the returned struct for an individual container
id string
image string
imageid string
command []string
createdat string
runningfor string
status string
ports ContainerPortMappings
rootfssize int
rwsize int
names string
labels map[string]
mounts ContainerMount
containerrunning bool
namespaces ContainerNameSpace
ContainerStats is the return struct for the stats of a container
id string
name string
cpu float
cpu_nano int
system_nano int
mem_usage int
mem_limit int
mem_perc float
net_input int
net_output int
block_output int
block_input int
pids int