github.com/containers/podman/v2@v2.2.2-0.20210501105131-c1e07d070c4c/API.md (about) 1 # io.podman 2 Podman Service Interface and API description. The master version of this document can be found 3 in the [API.md](https://github.com/containers/podman/blob/master/API.md) file in the upstream libpod repository. 4 ## Index 5 6 [func Attach(name: string, detachKeys: string, start: bool) ](#Attach) 7 8 [func AttachControl(name: string) ](#AttachControl) 9 10 [func BuildImage(build: BuildInfo) MoreResponse](#BuildImage) 11 12 [func BuildImageHierarchyMap(name: string) string](#BuildImageHierarchyMap) 13 14 [func Commit(name: string, image_name: string, changes: []string, author: string, message: string, pause: bool, manifestType: string) MoreResponse](#Commit) 15 16 [func ContainerArtifacts(name: string, artifactName: string) string](#ContainerArtifacts) 17 18 [func ContainerCheckpoint(name: string, keep: bool, leaveRunning: bool, tcpEstablished: bool) string](#ContainerCheckpoint) 19 20 [func ContainerConfig(name: string) string](#ContainerConfig) 21 22 [func ContainerExists(name: string) int](#ContainerExists) 23 24 [func ContainerInspectData(name: string, size: bool) string](#ContainerInspectData) 25 26 [func ContainerRestore(name: string, keep: bool, tcpEstablished: bool) string](#ContainerRestore) 27 28 [func ContainerRunlabel(runlabel: Runlabel) ](#ContainerRunlabel) 29 30 [func ContainerStateData(name: string) string](#ContainerStateData) 31 32 [func CreateContainer(create: Create) string](#CreateContainer) 33 34 [func CreateFromCC(in: []string) string](#CreateFromCC) 35 36 [func CreatePod(create: PodCreate) string](#CreatePod) 37 38 [func DeleteStoppedContainers() []string](#DeleteStoppedContainers) 39 40 [func DeleteUnusedImages() []string](#DeleteUnusedImages) 41 42 [func Diff(name: string) DiffInfo](#Diff) 43 44 [func EvictContainer(name: string, removeVolumes: bool) string](#EvictContainer) 45 46 [func ExecContainer(opts: ExecOpts) ](#ExecContainer) 47 48 [func ExportContainer(name: string, path: string) string](#ExportContainer) 49 50 [func ExportImage(name: string, destination: string, compress: bool, tags: []string) string](#ExportImage) 51 52 [func GenerateKube(name: string, service: bool) KubePodService](#GenerateKube) 53 54 [func GetAttachSockets(name: string) Sockets](#GetAttachSockets) 55 56 [func GetContainer(id: string) Container](#GetContainer) 57 58 [func GetContainerLogs(name: string) []string](#GetContainerLogs) 59 60 [func GetContainerStats(name: string) ContainerStats](#GetContainerStats) 61 62 [func GetContainerStatsWithHistory(previousStats: ContainerStats) ContainerStats](#GetContainerStatsWithHistory) 63 64 [func GetContainersByContext(all: bool, latest: bool, args: []string) []string](#GetContainersByContext) 65 66 [func GetContainersByStatus(status: []string) Container](#GetContainersByStatus) 67 68 [func GetContainersLogs(names: []string, follow: bool, latest: bool, since: string, tail: int, timestamps: bool) LogLine](#GetContainersLogs) 69 70 [func GetEvents(filter: []string, since: string, until: string) Event](#GetEvents) 71 72 [func GetImage(id: string) Image](#GetImage) 73 74 [func GetInfo() PodmanInfo](#GetInfo) 75 76 [func GetLayersMapWithImageInfo() string](#GetLayersMapWithImageInfo) 77 78 [func GetPod(name: string) ListPodData](#GetPod) 79 80 [func GetPodStats(name: string) string, ContainerStats](#GetPodStats) 81 82 [func GetPodsByContext(all: bool, latest: bool, args: []string) []string](#GetPodsByContext) 83 84 [func GetPodsByStatus(statuses: []string) []string](#GetPodsByStatus) 85 86 [func GetVersion() string, string, string, string, string, int](#GetVersion) 87 88 [func GetVolumes(args: []string, all: bool) Volume](#GetVolumes) 89 90 [func HealthCheckRun(nameOrID: string) string](#HealthCheckRun) 91 92 [func HistoryImage(name: string) ImageHistory](#HistoryImage) 93 94 [func ImageExists(name: string) int](#ImageExists) 95 96 [func ImageSave(options: ImageSaveOptions) MoreResponse](#ImageSave) 97 98 [func ImageTree(name: string, whatRequires: bool) string](#ImageTree) 99 100 [func ImagesPrune(all: bool, filter: []string) []string](#ImagesPrune) 101 102 [func ImportImage(source: string, reference: string, message: string, changes: []string, delete: bool) string](#ImportImage) 103 104 [func InitContainer(name: string) string](#InitContainer) 105 106 [func InspectContainer(name: string) string](#InspectContainer) 107 108 [func InspectImage(name: string) string](#InspectImage) 109 110 [func InspectPod(name: string) string](#InspectPod) 111 112 [func InspectVolume(name: string) string](#InspectVolume) 113 114 [func KillContainer(name: string, signal: int) string](#KillContainer) 115 116 [func KillPod(name: string, signal: int) string](#KillPod) 117 118 [func ListContainerChanges(name: string) ContainerChanges](#ListContainerChanges) 119 120 [func ListContainerMounts() map[string]](#ListContainerMounts) 121 122 [func ListContainerProcesses(name: string, opts: []string) []string](#ListContainerProcesses) 123 124 [func ListContainers() Container](#ListContainers) 125 126 [func ListImages() Image](#ListImages) 127 128 [func ListImagesWithFilters(filters: []string) Image](#ListImagesWithFilters) 129 130 [func ListPods() ListPodData](#ListPods) 131 132 [func LoadImage(name: string, inputFile: string, quiet: bool, deleteFile: bool) MoreResponse](#LoadImage) 133 134 [func MountContainer(name: string) string](#MountContainer) 135 136 [func PauseContainer(name: string) string](#PauseContainer) 137 138 [func PausePod(name: string) string](#PausePod) 139 140 [func PodStateData(name: string) string](#PodStateData) 141 142 [func Ps(opts: PsOpts) PsContainer](#Ps) 143 144 [func PullImage(name: string, creds: AuthConfig) MoreResponse](#PullImage) 145 146 [func PushImage(name: string, tag: string, compress: bool, format: string, removeSignatures: bool, signBy: string) MoreResponse](#PushImage) 147 148 [func ReceiveFile(path: string, delete: bool) int](#ReceiveFile) 149 150 [func RemoveContainer(name: string, force: bool, removeVolumes: bool) string](#RemoveContainer) 151 152 [func RemoveImage(name: string, force: bool) string](#RemoveImage) 153 154 [func RemoveImageWithResponse(name: string, force: bool) RemoveImageResponse](#RemoveImageWithResponse) 155 156 [func RemovePod(name: string, force: bool) string](#RemovePod) 157 158 [func Reset() ](#Reset) 159 160 [func RestartContainer(name: string, timeout: int) string](#RestartContainer) 161 162 [func RestartPod(name: string) string](#RestartPod) 163 164 [func SearchImages(query: string, limit: ?int, filter: ImageSearchFilter) ImageSearchResult](#SearchImages) 165 166 [func SendFile(type: string, length: int) string](#SendFile) 167 168 [func Spec(name: string) string](#Spec) 169 170 [func StartContainer(name: string) string](#StartContainer) 171 172 [func StartPod(name: string) string](#StartPod) 173 174 [func StopContainer(name: string, timeout: int) string](#StopContainer) 175 176 [func StopPod(name: string, timeout: int) string](#StopPod) 177 178 [func TagImage(name: string, tagged: string) string](#TagImage) 179 180 [func Top(nameOrID: string, descriptors: []string) []string](#Top) 181 182 [func TopPod(pod: string, latest: bool, descriptors: []string) []string](#TopPod) 183 184 [func UnmountContainer(name: string, force: bool) ](#UnmountContainer) 185 186 [func UnpauseContainer(name: string) string](#UnpauseContainer) 187 188 [func UnpausePod(name: string) string](#UnpausePod) 189 190 [func UntagImage(name: string, tag: string) string](#UntagImage) 191 192 [func VolumeCreate(options: VolumeCreateOpts) string](#VolumeCreate) 193 194 [func VolumeRemove(options: VolumeRemoveOpts) []string, map[string]](#VolumeRemove) 195 196 [func VolumesPrune() []string, []string](#VolumesPrune) 197 198 [func WaitContainer(name: string, interval: int) int](#WaitContainer) 199 200 [type AuthConfig](#AuthConfig) 201 202 [type BuildInfo](#BuildInfo) 203 204 [type BuildOptions](#BuildOptions) 205 206 [type Container](#Container) 207 208 [type ContainerChanges](#ContainerChanges) 209 210 [type ContainerMount](#ContainerMount) 211 212 [type ContainerNameSpace](#ContainerNameSpace) 213 214 [type ContainerPortMappings](#ContainerPortMappings) 215 216 [type ContainerStats](#ContainerStats) 217 218 [type Create](#Create) 219 220 [type DiffInfo](#DiffInfo) 221 222 [type Event](#Event) 223 224 [type ExecOpts](#ExecOpts) 225 226 [type Image](#Image) 227 228 [type ImageHistory](#ImageHistory) 229 230 [type ImageSaveOptions](#ImageSaveOptions) 231 232 [type ImageSearchFilter](#ImageSearchFilter) 233 234 [type ImageSearchResult](#ImageSearchResult) 235 236 [type InfoDistribution](#InfoDistribution) 237 238 [type InfoGraphStatus](#InfoGraphStatus) 239 240 [type InfoHost](#InfoHost) 241 242 [type InfoPodmanBinary](#InfoPodmanBinary) 243 244 [type InfoRegistry](#InfoRegistry) 245 246 [type InfoStore](#InfoStore) 247 248 [type KubePodService](#KubePodService) 249 250 [type ListPodContainerInfo](#ListPodContainerInfo) 251 252 [type ListPodData](#ListPodData) 253 254 [type LogLine](#LogLine) 255 256 [type MoreResponse](#MoreResponse) 257 258 [type NotImplemented](#NotImplemented) 259 260 [type PodContainerErrorData](#PodContainerErrorData) 261 262 [type PodCreate](#PodCreate) 263 264 [type PodmanInfo](#PodmanInfo) 265 266 [type PsContainer](#PsContainer) 267 268 [type PsOpts](#PsOpts) 269 270 [type RemoveImageResponse](#RemoveImageResponse) 271 272 [type Runlabel](#Runlabel) 273 274 [type Sockets](#Sockets) 275 276 [type StringResponse](#StringResponse) 277 278 [type Volume](#Volume) 279 280 [type VolumeCreateOpts](#VolumeCreateOpts) 281 282 [type VolumeRemoveOpts](#VolumeRemoveOpts) 283 284 [error ContainerNotFound](#ContainerNotFound) 285 286 [error ErrCtrStopped](#ErrCtrStopped) 287 288 [error ErrRequiresCgroupsV2ForRootless](#ErrRequiresCgroupsV2ForRootless) 289 290 [error ErrorOccurred](#ErrorOccurred) 291 292 [error ImageNotFound](#ImageNotFound) 293 294 [error InvalidState](#InvalidState) 295 296 [error NoContainerRunning](#NoContainerRunning) 297 298 [error NoContainersInPod](#NoContainersInPod) 299 300 [error PodContainerError](#PodContainerError) 301 302 [error PodNotFound](#PodNotFound) 303 304 [error RuntimeError](#RuntimeError) 305 306 [error VolumeNotFound](#VolumeNotFound) 307 308 [error WantsMoreRequired](#WantsMoreRequired) 309 310 ## Methods 311 ### <a name="Attach"></a>func Attach 312 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 313 314 method Attach(name: [string](https://godoc.org/builtin#string), detachKeys: [string](https://godoc.org/builtin#string), start: [bool](https://godoc.org/builtin#bool)) </div> 315 Attach takes the name or ID of a container and sets up the ability to remotely attach to its console. The start 316 bool is whether you wish to start the container in question first. 317 ### <a name="AttachControl"></a>func AttachControl 318 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 319 320 method AttachControl(name: [string](https://godoc.org/builtin#string)) </div> 321 322 ### <a name="BuildImage"></a>func BuildImage 323 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 324 325 method BuildImage(build: [BuildInfo](#BuildInfo)) [MoreResponse](#MoreResponse)</div> 326 BuildImage takes a [BuildInfo](#BuildInfo) structure and builds an image. At a minimum, you must provide the 327 contextDir tarball path, the 'dockerfiles' path, and 'output' option in the BuildInfo structure. The 'output' 328 options is the name of the of the resulting build. It will return a [MoreResponse](#MoreResponse) structure 329 that contains the build logs and resulting image ID. 330 #### Example 331 ~~~ 332 $ sudo varlink call -m unix:///run/podman/io.podman/io.podman.BuildImage '{"build":{"contextDir":"/tmp/t/context.tar","dockerfiles":["Dockerfile"], "output":"foobar"}}' 333 { 334 "image": { 335 "id": "", 336 "logs": [ 337 "STEP 1: FROM alpine\n" 338 ] 339 } 340 } 341 { 342 "image": { 343 "id": "", 344 "logs": [ 345 "STEP 2: COMMIT foobar\n" 346 ] 347 } 348 } 349 { 350 "image": { 351 "id": "", 352 "logs": [ 353 "b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9\n" 354 ] 355 } 356 } 357 { 358 "image": { 359 "id": "b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9", 360 "logs": [] 361 } 362 } 363 ~~~ 364 ### <a name="BuildImageHierarchyMap"></a>func BuildImageHierarchyMap 365 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 366 367 method BuildImageHierarchyMap(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 368 BuildImageHierarchyMap is for the development of Podman and should not be used. 369 ### <a name="Commit"></a>func Commit 370 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 371 372 method Commit(name: [string](https://godoc.org/builtin#string), image_name: [string](https://godoc.org/builtin#string), changes: [[]string](#[]string), author: [string](https://godoc.org/builtin#string), message: [string](https://godoc.org/builtin#string), pause: [bool](https://godoc.org/builtin#bool), manifestType: [string](https://godoc.org/builtin#string)) [MoreResponse](#MoreResponse)</div> 373 Commit, creates an image from an existing container. It requires the name or 374 ID of the container as well as the resulting image name. Optionally, you can define an author and message 375 to be added to the resulting image. You can also define changes to the resulting image for the following 376 attributes: _CMD, ENTRYPOINT, ENV, EXPOSE, LABEL, ONBUILD, STOPSIGNAL, USER, VOLUME, and WORKDIR_. To pause the 377 container while it is being committed, pass a _true_ bool for the pause argument. If the container cannot 378 be found by the ID or name provided, a (ContainerNotFound)[#ContainerNotFound] error will be returned; otherwise, 379 the resulting image's ID will be returned as a string inside a MoreResponse. 380 ### <a name="ContainerArtifacts"></a>func ContainerArtifacts 381 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 382 383 method ContainerArtifacts(name: [string](https://godoc.org/builtin#string), artifactName: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 384 ContainerArtifacts returns a container's artifacts in string form. This call is for 385 development of Podman only and generally should not be used. 386 ### <a name="ContainerCheckpoint"></a>func ContainerCheckpoint 387 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 388 389 method ContainerCheckpoint(name: [string](https://godoc.org/builtin#string), keep: [bool](https://godoc.org/builtin#bool), leaveRunning: [bool](https://godoc.org/builtin#bool), tcpEstablished: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 390 ContainerCheckPoint performs a checkpopint on a container by its name or full/partial container 391 ID. On successful checkpoint, the id of the checkpointed container is returned. 392 ### <a name="ContainerConfig"></a>func ContainerConfig 393 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 394 395 method ContainerConfig(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 396 ContainerConfig returns a container's config in string form. This call is for 397 development of Podman only and generally should not be used. 398 ### <a name="ContainerExists"></a>func ContainerExists 399 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 400 401 method ContainerExists(name: [string](https://godoc.org/builtin#string)) [int](https://godoc.org/builtin#int)</div> 402 ContainerExists takes a full or partial container ID or name and returns an int as to 403 whether the container exists in local storage. A result of 0 means the container does 404 exists; whereas a result of 1 means it could not be found. 405 #### Example 406 ~~~ 407 $ varlink call -m unix:/run/podman/io.podman/io.podman.ContainerExists '{"name": "flamboyant_payne"}'{ 408 "exists": 0 409 } 410 ~~~ 411 ### <a name="ContainerInspectData"></a>func ContainerInspectData 412 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 413 414 method ContainerInspectData(name: [string](https://godoc.org/builtin#string), size: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 415 ContainerInspectData returns a container's inspect data in string form. This call is for 416 development of Podman only and generally should not be used. 417 ### <a name="ContainerRestore"></a>func ContainerRestore 418 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 419 420 method ContainerRestore(name: [string](https://godoc.org/builtin#string), keep: [bool](https://godoc.org/builtin#bool), tcpEstablished: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 421 ContainerRestore restores a container that has been checkpointed. The container to be restored can 422 be identified by its name or full/partial container ID. A successful restore will result in the return 423 of the container's ID. 424 ### <a name="ContainerRunlabel"></a>func ContainerRunlabel 425 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 426 427 method ContainerRunlabel(runlabel: [Runlabel](#Runlabel)) </div> 428 ContainerRunlabel runs executes a command as described by a given container image label. 429 ### <a name="ContainerStateData"></a>func ContainerStateData 430 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 431 432 method ContainerStateData(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 433 ContainerStateData returns a container's state config in string form. This call is for 434 development of Podman only and generally should not be used. 435 ### <a name="CreateContainer"></a>func CreateContainer 436 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 437 438 method CreateContainer(create: [Create](#Create)) [string](https://godoc.org/builtin#string)</div> 439 CreateContainer creates a new container from an image. It uses a [Create](#Create) type for input. 440 ### <a name="CreateFromCC"></a>func CreateFromCC 441 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 442 443 method CreateFromCC(in: [[]string](#[]string)) [string](https://godoc.org/builtin#string)</div> 444 This call is for the development of Podman only and should not be used. 445 ### <a name="CreatePod"></a>func CreatePod 446 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 447 448 method CreatePod(create: [PodCreate](#PodCreate)) [string](https://godoc.org/builtin#string)</div> 449 CreatePod creates a new empty pod. It uses a [PodCreate](#PodCreate) type for input. 450 On success, the ID of the newly created pod will be returned. 451 #### Example 452 ~~~ 453 $ varlink call unix:/run/podman/io.podman/io.podman.CreatePod '{"create": {"name": "test"}}' 454 { 455 "pod": "b05dee7bd4ccfee688099fe1588a7a898d6ddd6897de9251d4671c9b0feacb2a" 456 } 457 # $ varlink call unix:/run/podman/io.podman/io.podman.CreatePod '{"create": {"infra": true, "share": ["ipc", "net", "uts"]}}' 458 { 459 "pod": "d7697449a8035f613c1a8891286502aca68fff7d5d49a85279b3bda229af3b28" 460 } 461 ~~~ 462 ### <a name="DeleteStoppedContainers"></a>func DeleteStoppedContainers 463 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 464 465 method DeleteStoppedContainers() [[]string](#[]string)</div> 466 DeleteStoppedContainers will delete all containers that are not running. It will return a list the deleted 467 container IDs. See also [RemoveContainer](RemoveContainer). 468 #### Example 469 ~~~ 470 $ varlink call -m unix:/run/podman/io.podman/io.podman.DeleteStoppedContainers 471 { 472 "containers": [ 473 "451410b931d00def8aa9b4f8084e4d4a39e5e04ea61f358cf53a5cf95afcdcee", 474 "8b60f754a3e01389494a9581ade97d35c2765b6e2f19acd2d3040c82a32d1bc0", 475 "cf2e99d4d3cad6073df199ed32bbe64b124f3e1aba6d78821aa8460e70d30084", 476 "db901a329587312366e5ecff583d08f0875b4b79294322df67d90fc6eed08fc1" 477 ] 478 } 479 ~~~ 480 ### <a name="DeleteUnusedImages"></a>func DeleteUnusedImages 481 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 482 483 method DeleteUnusedImages() [[]string](#[]string)</div> 484 DeleteUnusedImages deletes any images not associated with a container. The IDs of the deleted images are returned 485 in a string array. 486 #### Example 487 ~~~ 488 $ varlink call -m unix:/run/podman/io.podman/io.podman.DeleteUnusedImages 489 { 490 "images": [ 491 "166ea6588079559c724c15223f52927f514f73dd5c5cf2ae2d143e3b2e6e9b52", 492 "da86e6ba6ca197bf6bc5e9d900febd906b133eaa4750e6bed647b0fbe50ed43e", 493 "3ef70f7291f47dfe2b82931a993e16f5a44a0e7a68034c3e0e086d77f5829adc", 494 "59788edf1f3e78cd0ebe6ce1446e9d10788225db3dedcfd1a59f764bad2b2690" 495 ] 496 } 497 ~~~ 498 ### <a name="Diff"></a>func Diff 499 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 500 501 method Diff(name: [string](https://godoc.org/builtin#string)) [DiffInfo](#DiffInfo)</div> 502 Diff returns a diff between libpod objects 503 ### <a name="EvictContainer"></a>func EvictContainer 504 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 505 506 method EvictContainer(name: [string](https://godoc.org/builtin#string), removeVolumes: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 507 EvictContainer requires the name or ID of a container as well as a boolean that 508 indicates to remove builtin volumes. Upon successful eviction of the container, 509 its ID is returned. If the container cannot be found by name or ID, 510 a [ContainerNotFound](#ContainerNotFound) error will be returned. 511 See also [RemoveContainer](RemoveContainer). 512 #### Example 513 ~~~ 514 $ varlink call -m unix:/run/podman/io.podman/io.podman.EvictContainer '{"name": "62f4fd98cb57"}' 515 { 516 "container": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" 517 } 518 ~~~ 519 ### <a name="ExecContainer"></a>func ExecContainer 520 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 521 522 method ExecContainer(opts: [ExecOpts](#ExecOpts)) </div> 523 ExecContainer executes a command in the given container. 524 ### <a name="ExportContainer"></a>func ExportContainer 525 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 526 527 method ExportContainer(name: [string](https://godoc.org/builtin#string), path: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 528 ExportContainer creates an image from a container. It takes the name or ID of a container and a 529 path representing the target tarfile. If the container cannot be found, a [ContainerNotFound](#ContainerNotFound) 530 error will be returned. 531 The return value is the written tarfile. 532 #### Example 533 ~~~ 534 $ varlink call -m unix:/run/podman/io.podman/io.podman.ExportContainer '{"name": "flamboyant_payne", "path": "/tmp/payne.tar" }' 535 { 536 "tarfile": "/tmp/payne.tar" 537 } 538 ~~~ 539 ### <a name="ExportImage"></a>func ExportImage 540 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 541 542 method ExportImage(name: [string](https://godoc.org/builtin#string), destination: [string](https://godoc.org/builtin#string), compress: [bool](https://godoc.org/builtin#bool), tags: [[]string](#[]string)) [string](https://godoc.org/builtin#string)</div> 543 ExportImage takes the name or ID of an image and exports it to a destination like a tarball. There is also 544 a boolean option to force compression. It also takes in a string array of tags to be able to save multiple 545 tags of the same image to a tarball (each tag should be of the form <image>:<tag>). Upon completion, the ID 546 of the image is returned. If the image cannot be found in local storage, an [ImageNotFound](#ImageNotFound) 547 error will be returned. See also [ImportImage](ImportImage). 548 ### <a name="GenerateKube"></a>func GenerateKube 549 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 550 551 method GenerateKube(name: [string](https://godoc.org/builtin#string), service: [bool](https://godoc.org/builtin#bool)) [KubePodService](#KubePodService)</div> 552 GenerateKube generates a Kubernetes v1 Pod description of a Podman container or pod 553 and its containers. The description is in YAML. See also [ReplayKube](ReplayKube). 554 ### <a name="GetAttachSockets"></a>func GetAttachSockets 555 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 556 557 method GetAttachSockets(name: [string](https://godoc.org/builtin#string)) [Sockets](#Sockets)</div> 558 GetAttachSockets takes the name or ID of an existing container. It returns file paths for two sockets needed 559 to properly communicate with a container. The first is the actual I/O socket that the container uses. The 560 second is a "control" socket where things like resizing the TTY events are sent. If the container cannot be 561 found, a [ContainerNotFound](#ContainerNotFound) error will be returned. 562 #### Example 563 ~~~ 564 $ varlink call -m unix:/run/io.podman/io.podman.GetAttachSockets '{"name": "b7624e775431219161"}' 565 { 566 "sockets": { 567 "container_id": "b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca", 568 "control_socket": "/var/lib/containers/storage/overlay-containers/b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca/userdata/ctl", 569 "io_socket": "/var/run/libpod/socket/b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca/attach" 570 } 571 } 572 ~~~ 573 ### <a name="GetContainer"></a>func GetContainer 574 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 575 576 method GetContainer(id: [string](https://godoc.org/builtin#string)) [Container](#Container)</div> 577 GetContainer returns information about a single container. If a container 578 with the given id doesn't exist, a [ContainerNotFound](#ContainerNotFound) 579 error will be returned. See also [ListContainers](ListContainers) and 580 [InspectContainer](#InspectContainer). 581 ### <a name="GetContainerLogs"></a>func GetContainerLogs 582 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 583 584 method GetContainerLogs(name: [string](https://godoc.org/builtin#string)) [[]string](#[]string)</div> 585 GetContainerLogs takes a name or ID of a container and returns the logs of that container. 586 If the container cannot be found, a [ContainerNotFound](#ContainerNotFound) error will be returned. 587 The container logs are returned as an array of strings. GetContainerLogs will honor the streaming 588 capability of varlink if the client invokes it. 589 ### <a name="GetContainerStats"></a>func GetContainerStats 590 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 591 592 method GetContainerStats(name: [string](https://godoc.org/builtin#string)) [ContainerStats](#ContainerStats)</div> 593 GetContainerStats takes the name or ID of a container and returns a single ContainerStats structure which 594 contains attributes like memory and cpu usage. If the container cannot be found, a 595 [ContainerNotFound](#ContainerNotFound) error will be returned. If the container is not running, a [NoContainerRunning](#NoContainerRunning) 596 error will be returned 597 #### Example 598 ~~~ 599 $ varlink call -m unix:/run/podman/io.podman/io.podman.GetContainerStats '{"name": "c33e4164f384"}' 600 { 601 "container": { 602 "block_input": 0, 603 "block_output": 0, 604 "cpu": 2.571123918839990154678e-08, 605 "cpu_nano": 49037378, 606 "id": "c33e4164f384aa9d979072a63319d66b74fd7a128be71fa68ede24f33ec6cfee", 607 "mem_limit": 33080606720, 608 "mem_perc": 2.166828456524753747370e-03, 609 "mem_usage": 716800, 610 "name": "competent_wozniak", 611 "net_input": 768, 612 "net_output": 5910, 613 "pids": 1, 614 "system_nano": 10000000 615 } 616 } 617 ~~~ 618 ### <a name="GetContainerStatsWithHistory"></a>func GetContainerStatsWithHistory 619 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 620 621 method GetContainerStatsWithHistory(previousStats: [ContainerStats](#ContainerStats)) [ContainerStats](#ContainerStats)</div> 622 GetContainerStatsWithHistory takes a previous set of container statistics and uses libpod functions 623 to calculate the containers statistics based on current and previous measurements. 624 ### <a name="GetContainersByContext"></a>func GetContainersByContext 625 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 626 627 method GetContainersByContext(all: [bool](https://godoc.org/builtin#bool), latest: [bool](https://godoc.org/builtin#bool), args: [[]string](#[]string)) [[]string](#[]string)</div> 628 GetContainersByContext allows you to get a list of container ids depending on all, latest, or a list of 629 container names. The definition of latest container means the latest by creation date. In a multi- 630 user environment, results might differ from what you expect. 631 ### <a name="GetContainersByStatus"></a>func GetContainersByStatus 632 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 633 634 method GetContainersByStatus(status: [[]string](#[]string)) [Container](#Container)</div> 635 636 ### <a name="GetContainersLogs"></a>func GetContainersLogs 637 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 638 639 method GetContainersLogs(names: [[]string](#[]string), follow: [bool](https://godoc.org/builtin#bool), latest: [bool](https://godoc.org/builtin#bool), since: [string](https://godoc.org/builtin#string), tail: [int](https://godoc.org/builtin#int), timestamps: [bool](https://godoc.org/builtin#bool)) [LogLine](#LogLine)</div> 640 641 ### <a name="GetEvents"></a>func GetEvents 642 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 643 644 method GetEvents(filter: [[]string](#[]string), since: [string](https://godoc.org/builtin#string), until: [string](https://godoc.org/builtin#string)) [Event](#Event)</div> 645 GetEvents returns known libpod events filtered by the options provided. 646 ### <a name="GetImage"></a>func GetImage 647 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 648 649 method GetImage(id: [string](https://godoc.org/builtin#string)) [Image](#Image)</div> 650 GetImage returns information about a single image in storage. 651 If the image caGetImage returns be found, [ImageNotFound](#ImageNotFound) will be returned. 652 ### <a name="GetInfo"></a>func GetInfo 653 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 654 655 method GetInfo() [PodmanInfo](#PodmanInfo)</div> 656 GetInfo returns a [PodmanInfo](#PodmanInfo) struct that describes podman and its host such as storage stats, 657 build information of Podman, and system-wide registries. 658 ### <a name="GetLayersMapWithImageInfo"></a>func GetLayersMapWithImageInfo 659 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 660 661 method GetLayersMapWithImageInfo() [string](https://godoc.org/builtin#string)</div> 662 GetLayersMapWithImageInfo is for the development of Podman and should not be used. 663 ### <a name="GetPod"></a>func GetPod 664 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 665 666 method GetPod(name: [string](https://godoc.org/builtin#string)) [ListPodData](#ListPodData)</div> 667 GetPod takes a name or ID of a pod and returns single [ListPodData](#ListPodData) 668 structure. A [PodNotFound](#PodNotFound) error will be returned if the pod cannot be found. 669 See also [ListPods](ListPods). 670 #### Example 671 ~~~ 672 $ varlink call -m unix:/run/podman/io.podman/io.podman.GetPod '{"name": "foobar"}' 673 { 674 "pod": { 675 "cgroup": "machine.slice", 676 "containersinfo": [ 677 { 678 "id": "00c130a45de0411f109f1a0cfea2e298df71db20fa939de5cab8b2160a36be45", 679 "name": "1840835294cf-infra", 680 "status": "running" 681 }, 682 { 683 "id": "49a5cce72093a5ca47c6de86f10ad7bb36391e2d89cef765f807e460865a0ec6", 684 "name": "upbeat_murdock", 685 "status": "running" 686 } 687 ], 688 "createdat": "2018-12-07 13:10:15.014139258 -0600 CST", 689 "id": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f", 690 "name": "foobar", 691 "numberofcontainers": "2", 692 "status": "Running" 693 } 694 } 695 ~~~ 696 ### <a name="GetPodStats"></a>func GetPodStats 697 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 698 699 method GetPodStats(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string), [ContainerStats](#ContainerStats)</div> 700 GetPodStats takes the name or ID of a pod and returns a pod name and slice of ContainerStats structure which 701 contains attributes like memory and cpu usage. If the pod cannot be found, a [PodNotFound](#PodNotFound) 702 error will be returned. If the pod has no running containers associated with it, a [NoContainerRunning](#NoContainerRunning) 703 error will be returned. 704 #### Example 705 ~~~ 706 $ varlink call unix:/run/podman/io.podman/io.podman.GetPodStats '{"name": "7f62b508b6f12b11d8fe02e"}' 707 { 708 "containers": [ 709 { 710 "block_input": 0, 711 "block_output": 0, 712 "cpu": 2.833470544016107524276e-08, 713 "cpu_nano": 54363072, 714 "id": "a64b51f805121fe2c5a3dc5112eb61d6ed139e3d1c99110360d08b58d48e4a93", 715 "mem_limit": 12276146176, 716 "mem_perc": 7.974359265237864966003e-03, 717 "mem_usage": 978944, 718 "name": "quirky_heisenberg", 719 "net_input": 866, 720 "net_output": 7388, 721 "pids": 1, 722 "system_nano": 20000000 723 } 724 ], 725 "pod": "7f62b508b6f12b11d8fe02e0db4de6b9e43a7d7699b33a4fc0d574f6e82b4ebd" 726 } 727 ~~~ 728 ### <a name="GetPodsByContext"></a>func GetPodsByContext 729 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 730 731 method GetPodsByContext(all: [bool](https://godoc.org/builtin#bool), latest: [bool](https://godoc.org/builtin#bool), args: [[]string](#[]string)) [[]string](#[]string)</div> 732 GetPodsByContext allows you to get a list pod ids depending on all, latest, or a list of 733 pod names. The definition of latest pod means the latest by creation date. In a multi- 734 user environment, results might differ from what you expect. 735 ### <a name="GetPodsByStatus"></a>func GetPodsByStatus 736 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 737 738 method GetPodsByStatus(statuses: [[]string](#[]string)) [[]string](#[]string)</div> 739 GetPodsByStatus searches for pods whose status is included in statuses 740 ### <a name="GetVersion"></a>func GetVersion 741 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 742 743 method GetVersion() [string](https://godoc.org/builtin#string), [string](https://godoc.org/builtin#string), [string](https://godoc.org/builtin#string), [string](https://godoc.org/builtin#string), [string](https://godoc.org/builtin#string), [int](https://godoc.org/builtin#int)</div> 744 GetVersion returns version and build information of the podman service 745 ### <a name="GetVolumes"></a>func GetVolumes 746 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 747 748 method GetVolumes(args: [[]string](#[]string), all: [bool](https://godoc.org/builtin#bool)) [Volume](#Volume)</div> 749 GetVolumes gets slice of the volumes on a remote host 750 ### <a name="HealthCheckRun"></a>func HealthCheckRun 751 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 752 753 method HealthCheckRun(nameOrID: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 754 HealthCheckRun executes defined container's healthcheck command 755 and returns the container's health status. 756 ### <a name="HistoryImage"></a>func HistoryImage 757 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 758 759 method HistoryImage(name: [string](https://godoc.org/builtin#string)) [ImageHistory](#ImageHistory)</div> 760 HistoryImage takes the name or ID of an image and returns information about its history and layers. The returned 761 history is in the form of an array of ImageHistory structures. If the image cannot be found, an 762 [ImageNotFound](#ImageNotFound) error is returned. 763 ### <a name="ImageExists"></a>func ImageExists 764 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 765 766 method ImageExists(name: [string](https://godoc.org/builtin#string)) [int](https://godoc.org/builtin#int)</div> 767 ImageExists talks a full or partial image ID or name and returns an int as to whether 768 the image exists in local storage. An int result of 0 means the image does exist in 769 local storage; whereas 1 indicates the image does not exists in local storage. 770 #### Example 771 ~~~ 772 $ varlink call -m unix:/run/podman/io.podman/io.podman.ImageExists '{"name": "imageddoesntexist"}' 773 { 774 "exists": 1 775 } 776 ~~~ 777 ### <a name="ImageSave"></a>func ImageSave 778 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 779 780 method ImageSave(options: [ImageSaveOptions](#ImageSaveOptions)) [MoreResponse](#MoreResponse)</div> 781 ImageSave allows you to save an image from the local image storage to a tarball 782 ### <a name="ImageTree"></a>func ImageTree 783 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 784 785 method ImageTree(name: [string](https://godoc.org/builtin#string), whatRequires: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 786 ImageTree returns the image tree for the provided image name or ID 787 #### Example 788 ~~~ 789 $ varlink call -m unix:/run/podman/io.podman/io.podman.ImageTree '{"name": "alpine"}' 790 { 791 "tree": "Image ID: e7d92cdc71fe\nTags: [docker.io/library/alpine:latest]\nSize: 5.861MB\nImage Layers\nāāā ID: 5216338b40a7 Size: 5.857MB Top Layer of: [docker.io/library/alpine:latest]\n" 792 } 793 ~~~ 794 ### <a name="ImagesPrune"></a>func ImagesPrune 795 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 796 797 method ImagesPrune(all: [bool](https://godoc.org/builtin#bool), filter: [[]string](#[]string)) [[]string](#[]string)</div> 798 ImagesPrune removes all unused images from the local store. Upon successful pruning, 799 the IDs of the removed images are returned. 800 ### <a name="ImportImage"></a>func ImportImage 801 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 802 803 method ImportImage(source: [string](https://godoc.org/builtin#string), reference: [string](https://godoc.org/builtin#string), message: [string](https://godoc.org/builtin#string), changes: [[]string](#[]string), delete: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 804 ImportImage imports an image from a source (like tarball) into local storage. The image can have additional 805 descriptions added to it using the message and changes options. See also [ExportImage](ExportImage). 806 ### <a name="InitContainer"></a>func InitContainer 807 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 808 809 method InitContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 810 InitContainer initializes the given container. It accepts a container name or 811 ID, and will initialize the container matching that ID if possible, and error 812 if not. Containers can only be initialized when they are in the Created or 813 Exited states. Initialization prepares a container to be started, but does not 814 start the container. It is intended to be used to debug a container's state 815 prior to starting it. 816 ### <a name="InspectContainer"></a>func InspectContainer 817 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 818 819 method InspectContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 820 InspectContainer data takes a name or ID of a container returns the inspection 821 data in string format. You can then serialize the string into JSON. A [ContainerNotFound](#ContainerNotFound) 822 error will be returned if the container cannot be found. See also [InspectImage](#InspectImage). 823 ### <a name="InspectImage"></a>func InspectImage 824 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 825 826 method InspectImage(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 827 InspectImage takes the name or ID of an image and returns a string representation of data associated with the 828 mage. You must serialize the string into JSON to use it further. An [ImageNotFound](#ImageNotFound) error will 829 be returned if the image cannot be found. 830 ### <a name="InspectPod"></a>func InspectPod 831 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 832 833 method InspectPod(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 834 InspectPod takes the name or ID of an image and returns a string representation of data associated with the 835 pod. You must serialize the string into JSON to use it further. A [PodNotFound](#PodNotFound) error will 836 be returned if the pod cannot be found. 837 ### <a name="InspectVolume"></a>func InspectVolume 838 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 839 840 method InspectVolume(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 841 InspectVolume inspects a single volume. Returns inspect JSON in the form of a 842 string. 843 ### <a name="KillContainer"></a>func KillContainer 844 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 845 846 method KillContainer(name: [string](https://godoc.org/builtin#string), signal: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> 847 KillContainer takes the name or ID of a container as well as a signal to be applied to the container. Once the 848 container has been killed, the container's ID is returned. If the container cannot be found, a 849 [ContainerNotFound](#ContainerNotFound) error is returned. See also [StopContainer](StopContainer). 850 ### <a name="KillPod"></a>func KillPod 851 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 852 853 method KillPod(name: [string](https://godoc.org/builtin#string), signal: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> 854 KillPod takes the name or ID of a pod as well as a signal to be applied to the pod. If the pod cannot be found, a 855 [PodNotFound](#PodNotFound) error is returned. 856 Containers in a pod are killed independently. If there is an error killing one container, the ID of those containers 857 will be returned in a list, along with the ID of the pod in a [PodContainerError](#PodContainerError). 858 If the pod was killed with no errors, the pod ID is returned. 859 See also [StopPod](StopPod). 860 #### Example 861 ~~~ 862 $ varlink call -m unix:/run/podman/io.podman/io.podman.KillPod '{"name": "foobar", "signal": 15}' 863 { 864 "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" 865 } 866 ~~~ 867 ### <a name="ListContainerChanges"></a>func ListContainerChanges 868 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 869 870 method ListContainerChanges(name: [string](https://godoc.org/builtin#string)) [ContainerChanges](#ContainerChanges)</div> 871 ListContainerChanges takes a name or ID of a container and returns changes between the container and 872 its base image. It returns a struct of changed, deleted, and added path names. 873 ### <a name="ListContainerMounts"></a>func ListContainerMounts 874 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 875 876 method ListContainerMounts() [map[string]](#map[string])</div> 877 ListContainerMounts gathers all the mounted container mount points and returns them as an array 878 of strings 879 #### Example 880 ~~~ 881 $ varlink call unix:/run/podman/io.podman/io.podman.ListContainerMounts 882 { 883 "mounts": { 884 "04e4c255269ed2545e7f8bd1395a75f7949c50c223415c00c1d54bfa20f3b3d9": "/var/lib/containers/storage/overlay/a078925828f57e20467ca31cfca8a849210d21ec7e5757332b72b6924f441c17/merged", 885 "1d58c319f9e881a644a5122ff84419dccf6d138f744469281446ab243ef38924": "/var/lib/containers/storage/overlay/948fcf93f8cb932f0f03fd52e3180a58627d547192ffe3b88e0013b98ddcd0d2/merged" 886 } 887 } 888 ~~~ 889 ### <a name="ListContainerProcesses"></a>func ListContainerProcesses 890 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 891 892 method ListContainerProcesses(name: [string](https://godoc.org/builtin#string), opts: [[]string](#[]string)) [[]string](#[]string)</div> 893 ListContainerProcesses takes a name or ID of a container and returns the processes 894 running inside the container as array of strings. It will accept an array of string 895 arguments that represent ps options. If the container cannot be found, a [ContainerNotFound](#ContainerNotFound) 896 error will be returned. 897 #### Example 898 ~~~ 899 $ varlink call -m unix:/run/podman/io.podman/io.podman.ListContainerProcesses '{"name": "135d71b9495f", "opts": []}' 900 { 901 "container": [ 902 " UID PID PPID C STIME TTY TIME CMD", 903 " 0 21220 21210 0 09:05 pts/0 00:00:00 /bin/sh", 904 " 0 21232 21220 0 09:05 pts/0 00:00:00 top", 905 " 0 21284 21220 0 09:05 pts/0 00:00:00 vi /etc/hosts" 906 ] 907 } 908 ~~~ 909 ### <a name="ListContainers"></a>func ListContainers 910 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 911 912 method ListContainers() [Container](#Container)</div> 913 ListContainers returns information about all containers. 914 See also [GetContainer](#GetContainer). 915 ### <a name="ListImages"></a>func ListImages 916 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 917 918 method ListImages() [Image](#Image)</div> 919 ListImages returns information about the images that are currently in storage. 920 See also [InspectImage](#InspectImage). 921 ### <a name="ListImagesWithFilters"></a>func ListImagesWithFilters 922 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 923 924 method ListImagesWithFilters(filters: [[]string](#[]string)) [Image](#Image)</div> 925 ListImagesWithFilters returns information about the images that are currently in storage 926 after one or more filters has been applied. 927 See also [InspectImage](#InspectImage). 928 ### <a name="ListPods"></a>func ListPods 929 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 930 931 method ListPods() [ListPodData](#ListPodData)</div> 932 ListPods returns a list of pods in no particular order. They are 933 returned as an array of ListPodData structs. See also [GetPod](#GetPod). 934 #### Example 935 ~~~ 936 $ varlink call -m unix:/run/podman/io.podman/io.podman.ListPods 937 { 938 "pods": [ 939 { 940 "cgroup": "machine.slice", 941 "containersinfo": [ 942 { 943 "id": "00c130a45de0411f109f1a0cfea2e298df71db20fa939de5cab8b2160a36be45", 944 "name": "1840835294cf-infra", 945 "status": "running" 946 }, 947 { 948 "id": "49a5cce72093a5ca47c6de86f10ad7bb36391e2d89cef765f807e460865a0ec6", 949 "name": "upbeat_murdock", 950 "status": "running" 951 } 952 ], 953 "createdat": "2018-12-07 13:10:15.014139258 -0600 CST", 954 "id": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f", 955 "name": "foobar", 956 "numberofcontainers": "2", 957 "status": "Running" 958 }, 959 { 960 "cgroup": "machine.slice", 961 "containersinfo": [ 962 { 963 "id": "1ca4b7bbba14a75ba00072d4b705c77f3df87db0109afaa44d50cb37c04a477e", 964 "name": "784306f655c6-infra", 965 "status": "running" 966 } 967 ], 968 "createdat": "2018-12-07 13:09:57.105112457 -0600 CST", 969 "id": "784306f655c6200aea321dd430ba685e9b2cc1f7d7528a72f3ff74ffb29485a2", 970 "name": "nostalgic_pike", 971 "numberofcontainers": "1", 972 "status": "Running" 973 } 974 ] 975 } 976 ~~~ 977 ### <a name="LoadImage"></a>func LoadImage 978 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 979 980 method LoadImage(name: [string](https://godoc.org/builtin#string), inputFile: [string](https://godoc.org/builtin#string), quiet: [bool](https://godoc.org/builtin#bool), deleteFile: [bool](https://godoc.org/builtin#bool)) [MoreResponse](#MoreResponse)</div> 981 LoadImage allows you to load an image into local storage from a tarball. 982 ### <a name="MountContainer"></a>func MountContainer 983 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 984 985 method MountContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 986 MountContainer mounts a container by name or full/partial ID. Upon a successful mount, the destination 987 mount is returned as a string. 988 #### Example 989 ~~~ 990 $ varlink call -m unix:/run/podman/io.podman/io.podman.MountContainer '{"name": "jolly_shannon"}'{ 991 "path": "/var/lib/containers/storage/overlay/419eeb04e783ea159149ced67d9fcfc15211084d65e894792a96bedfae0470ca/merged" 992 } 993 ~~~ 994 ### <a name="PauseContainer"></a>func PauseContainer 995 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 996 997 method PauseContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 998 PauseContainer takes the name or ID of container and pauses it. If the container cannot be found, 999 a [ContainerNotFound](#ContainerNotFound) error will be returned; otherwise the ID of the container is returned. 1000 See also [UnpauseContainer](#UnpauseContainer). 1001 ### <a name="PausePod"></a>func PausePod 1002 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1003 1004 method PausePod(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1005 PausePod takes the name or ID of a pod and pauses the running containers associated with it. If the pod cannot be found, 1006 a [PodNotFound](#PodNotFound) error will be returned. 1007 Containers in a pod are paused independently. If there is an error pausing one container, the ID of those containers 1008 will be returned in a list, along with the ID of the pod in a [PodContainerError](#PodContainerError). 1009 If the pod was paused with no errors, the pod ID is returned. 1010 See also [UnpausePod](#UnpausePod). 1011 #### Example 1012 ~~~ 1013 $ varlink call -m unix:/run/podman/io.podman/io.podman.PausePod '{"name": "foobar"}' 1014 { 1015 "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" 1016 } 1017 ~~~ 1018 ### <a name="PodStateData"></a>func PodStateData 1019 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1020 1021 method PodStateData(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1022 PodStateData returns inspectr level information of a given pod in string form. This call is for 1023 development of Podman only and generally should not be used. 1024 ### <a name="Ps"></a>func Ps 1025 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1026 1027 method Ps(opts: [PsOpts](#PsOpts)) [PsContainer](#PsContainer)</div> 1028 1029 ### <a name="PullImage"></a>func PullImage 1030 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1031 1032 method PullImage(name: [string](https://godoc.org/builtin#string), creds: [AuthConfig](#AuthConfig)) [MoreResponse](#MoreResponse)</div> 1033 PullImage pulls an image from a repository to local storage. After a successful pull, the image id and logs 1034 are returned as a [MoreResponse](#MoreResponse). This connection also will handle a WantsMores request to send 1035 status as it occurs. 1036 ### <a name="PushImage"></a>func PushImage 1037 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1038 1039 method PushImage(name: [string](https://godoc.org/builtin#string), tag: [string](https://godoc.org/builtin#string), compress: [bool](https://godoc.org/builtin#bool), format: [string](https://godoc.org/builtin#string), removeSignatures: [bool](https://godoc.org/builtin#bool), signBy: [string](https://godoc.org/builtin#string)) [MoreResponse](#MoreResponse)</div> 1040 PushImage takes two input arguments: the name or ID of an image, the fully-qualified destination name of the image, 1041 It will return an [ImageNotFound](#ImageNotFound) error if 1042 the image cannot be found in local storage; otherwise it will return a [MoreResponse](#MoreResponse) 1043 ### <a name="ReceiveFile"></a>func ReceiveFile 1044 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1045 1046 method ReceiveFile(path: [string](https://godoc.org/builtin#string), delete: [bool](https://godoc.org/builtin#bool)) [int](https://godoc.org/builtin#int)</div> 1047 ReceiveFile allows the host to send a remote client a file 1048 ### <a name="RemoveContainer"></a>func RemoveContainer 1049 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1050 1051 method RemoveContainer(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool), removeVolumes: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 1052 RemoveContainer requires the name or ID of a container as well as a boolean that 1053 indicates whether a container should be forcefully removed (e.g., by stopping it), and a boolean 1054 indicating whether to remove builtin volumes. Upon successful removal of the 1055 container, its ID is returned. If the 1056 container cannot be found by name or ID, a [ContainerNotFound](#ContainerNotFound) error will be returned. 1057 See also [EvictContainer](EvictContainer). 1058 #### Example 1059 ~~~ 1060 $ varlink call -m unix:/run/podman/io.podman/io.podman.RemoveContainer '{"name": "62f4fd98cb57"}' 1061 { 1062 "container": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" 1063 } 1064 ~~~ 1065 ### <a name="RemoveImage"></a>func RemoveImage 1066 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1067 1068 method RemoveImage(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 1069 RemoveImage takes the name or ID of an image as well as a boolean that determines if containers using that image 1070 should be deleted. If the image cannot be found, an [ImageNotFound](#ImageNotFound) error will be returned. The 1071 ID of the removed image is returned when complete. See also [DeleteUnusedImages](DeleteUnusedImages). 1072 #### Example 1073 ~~~ 1074 varlink call -m unix:/run/podman/io.podman/io.podman.RemoveImage '{"name": "registry.fedoraproject.org/fedora", "force": true}' 1075 { 1076 "image": "426866d6fa419873f97e5cbd320eeb22778244c1dfffa01c944db3114f55772e" 1077 } 1078 ~~~ 1079 ### <a name="RemoveImageWithResponse"></a>func RemoveImageWithResponse 1080 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1081 1082 method RemoveImageWithResponse(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool)) [RemoveImageResponse](#RemoveImageResponse)</div> 1083 RemoveImageWithResponse takes the name or ID of an image as well as a boolean that determines if containers using that image 1084 should be deleted. If the image cannot be found, an [ImageNotFound](#ImageNotFound) error will be returned. The response is 1085 in the form of a RemoveImageResponse . 1086 ### <a name="RemovePod"></a>func RemovePod 1087 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1088 1089 method RemovePod(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> 1090 RemovePod takes the name or ID of a pod as well a boolean representing whether a running 1091 container in the pod can be stopped and removed. If a pod has containers associated with it, and force is not true, 1092 an error will occur. 1093 If the pod cannot be found by name or ID, a [PodNotFound](#PodNotFound) error will be returned. 1094 Containers in a pod are removed independently. If there is an error removing any container, the ID of those containers 1095 will be returned in a list, along with the ID of the pod in a [PodContainerError](#PodContainerError). 1096 If the pod was removed with no errors, the pod ID is returned. 1097 #### Example 1098 ~~~ 1099 $ varlink call -m unix:/run/podman/io.podman/io.podman.RemovePod '{"name": "62f4fd98cb57", "force": "true"}' 1100 { 1101 "pod": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" 1102 } 1103 ~~~ 1104 ### <a name="Reset"></a>func Reset 1105 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1106 1107 method Reset() </div> 1108 Reset resets Podman back to its initial state. 1109 Removes all Pods, Containers, Images and Volumes 1110 ### <a name="RestartContainer"></a>func RestartContainer 1111 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1112 1113 method RestartContainer(name: [string](https://godoc.org/builtin#string), timeout: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> 1114 RestartContainer will restart a running container given a container name or ID and timeout value. The timeout 1115 value is the time before a forcible stop is used to stop the container. If the container cannot be found by 1116 name or ID, a [ContainerNotFound](#ContainerNotFound) error will be returned; otherwise, the ID of the 1117 container will be returned. 1118 ### <a name="RestartPod"></a>func RestartPod 1119 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1120 1121 method RestartPod(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1122 RestartPod will restart containers in a pod given a pod name or ID. Containers in 1123 the pod that are running will be stopped, then all stopped containers will be run. 1124 If the pod cannot be found by name or ID, a [PodNotFound](#PodNotFound) error will be returned. 1125 Containers in a pod are restarted independently. If there is an error restarting one container, the ID of those containers 1126 will be returned in a list, along with the ID of the pod in a [PodContainerError](#PodContainerError). 1127 If the pod was restarted with no errors, the pod ID is returned. 1128 #### Example 1129 ~~~ 1130 $ varlink call -m unix:/run/podman/io.podman/io.podman.RestartPod '{"name": "135d71b9495f"}' 1131 { 1132 "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" 1133 } 1134 ~~~ 1135 ### <a name="SearchImages"></a>func SearchImages 1136 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1137 1138 method SearchImages(query: [string](https://godoc.org/builtin#string), limit: [?int](#?int), filter: [ImageSearchFilter](#ImageSearchFilter)) [ImageSearchResult](#ImageSearchResult)</div> 1139 SearchImages searches available registries for images that contain the 1140 contents of "query" in their name. If "limit" is given, limits the amount of 1141 search results per registry. 1142 ### <a name="SendFile"></a>func SendFile 1143 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1144 1145 method SendFile(type: [string](https://godoc.org/builtin#string), length: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> 1146 Sendfile allows a remote client to send a file to the host 1147 ### <a name="Spec"></a>func Spec 1148 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1149 1150 method Spec(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1151 Spec returns the oci spec for a container. This call is for development of Podman only and generally should not be used. 1152 ### <a name="StartContainer"></a>func StartContainer 1153 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1154 1155 method StartContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1156 StartContainer starts a created or stopped container. It takes the name or ID of container. It returns 1157 the container ID once started. If the container cannot be found, a [ContainerNotFound](#ContainerNotFound) 1158 error will be returned. See also [CreateContainer](#CreateContainer). 1159 ### <a name="StartPod"></a>func StartPod 1160 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1161 1162 method StartPod(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1163 StartPod starts containers in a pod. It takes the name or ID of pod. If the pod cannot be found, a [PodNotFound](#PodNotFound) 1164 error will be returned. Containers in a pod are started independently. If there is an error starting one container, the ID of those containers 1165 will be returned in a list, along with the ID of the pod in a [PodContainerError](#PodContainerError). 1166 If the pod was started with no errors, the pod ID is returned. 1167 See also [CreatePod](#CreatePod). 1168 #### Example 1169 ~~~ 1170 $ varlink call -m unix:/run/podman/io.podman/io.podman.StartPod '{"name": "135d71b9495f"}' 1171 { 1172 "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6", 1173 } 1174 ~~~ 1175 ### <a name="StopContainer"></a>func StopContainer 1176 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1177 1178 method StopContainer(name: [string](https://godoc.org/builtin#string), timeout: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> 1179 StopContainer stops a container given a timeout. It takes the name or ID of a container as well as a 1180 timeout value. The timeout value the time before a forcible stop to the container is applied. It 1181 returns the container ID once stopped. If the container cannot be found, a [ContainerNotFound](#ContainerNotFound) 1182 error will be returned instead. See also [KillContainer](KillContainer). 1183 #### Error 1184 ~~~ 1185 $ varlink call -m unix:/run/podman/io.podman/io.podman.StopContainer '{"name": "135d71b9495f", "timeout": 5}' 1186 { 1187 "container": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" 1188 } 1189 ~~~ 1190 ### <a name="StopPod"></a>func StopPod 1191 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1192 1193 method StopPod(name: [string](https://godoc.org/builtin#string), timeout: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> 1194 StopPod stops containers in a pod. It takes the name or ID of a pod and a timeout. 1195 If the pod cannot be found, a [PodNotFound](#PodNotFound) error will be returned instead. 1196 Containers in a pod are stopped independently. If there is an error stopping one container, the ID of those containers 1197 will be returned in a list, along with the ID of the pod in a [PodContainerError](#PodContainerError). 1198 If the pod was stopped with no errors, the pod ID is returned. 1199 See also [KillPod](KillPod). 1200 #### Example 1201 ~~~ 1202 $ varlink call -m unix:/run/podman/io.podman/io.podman.StopPod '{"name": "135d71b9495f"}' 1203 { 1204 "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" 1205 } 1206 ~~~ 1207 ### <a name="TagImage"></a>func TagImage 1208 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1209 1210 method TagImage(name: [string](https://godoc.org/builtin#string), tagged: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1211 TagImage takes the name or ID of an image in local storage as well as the desired tag name. If the image cannot 1212 be found, an [ImageNotFound](#ImageNotFound) error will be returned; otherwise, the ID of the image is returned on success. 1213 ### <a name="Top"></a>func Top 1214 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1215 1216 method Top(nameOrID: [string](https://godoc.org/builtin#string), descriptors: [[]string](#[]string)) [[]string](#[]string)</div> 1217 1218 ### <a name="TopPod"></a>func TopPod 1219 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1220 1221 method TopPod(pod: [string](https://godoc.org/builtin#string), latest: [bool](https://godoc.org/builtin#bool), descriptors: [[]string](#[]string)) [[]string](#[]string)</div> 1222 1223 ### <a name="UnmountContainer"></a>func UnmountContainer 1224 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1225 1226 method UnmountContainer(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool)) </div> 1227 UnmountContainer umounts a container by its name or full/partial container ID. 1228 #### Example 1229 ~~~ 1230 $ varlink call -m unix:/run/podman/io.podman/io.podman.UnmountContainer '{"name": "jolly_shannon", "force": false}' 1231 {} 1232 ~~~ 1233 ### <a name="UnpauseContainer"></a>func UnpauseContainer 1234 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1235 1236 method UnpauseContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1237 UnpauseContainer takes the name or ID of container and unpauses a paused container. If the container cannot be 1238 found, a [ContainerNotFound](#ContainerNotFound) error will be returned; otherwise the ID of the container is returned. 1239 See also [PauseContainer](#PauseContainer). 1240 ### <a name="UnpausePod"></a>func UnpausePod 1241 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1242 1243 method UnpausePod(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1244 UnpausePod takes the name or ID of a pod and unpauses the paused containers associated with it. If the pod cannot be 1245 found, a [PodNotFound](#PodNotFound) error will be returned. 1246 Containers in a pod are unpaused independently. If there is an error unpausing one container, the ID of those containers 1247 will be returned in a list, along with the ID of the pod in a [PodContainerError](#PodContainerError). 1248 If the pod was unpaused with no errors, the pod ID is returned. 1249 See also [PausePod](#PausePod). 1250 #### Example 1251 ~~~ 1252 $ varlink call -m unix:/run/podman/io.podman/io.podman.UnpausePod '{"name": "foobar"}' 1253 { 1254 "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" 1255 } 1256 ~~~ 1257 ### <a name="UntagImage"></a>func UntagImage 1258 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1259 1260 method UntagImage(name: [string](https://godoc.org/builtin#string), tag: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> 1261 UntagImage takes the name or ID of an image in local storage as well as the 1262 tag name to be removed. If the image cannot be found, an 1263 [ImageNotFound](#ImageNotFound) error will be returned; otherwise, the ID of 1264 the image is returned on success. 1265 ### <a name="VolumeCreate"></a>func VolumeCreate 1266 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1267 1268 method VolumeCreate(options: [VolumeCreateOpts](#VolumeCreateOpts)) [string](https://godoc.org/builtin#string)</div> 1269 VolumeCreate creates a volume on a remote host 1270 ### <a name="VolumeRemove"></a>func VolumeRemove 1271 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1272 1273 method VolumeRemove(options: [VolumeRemoveOpts](#VolumeRemoveOpts)) [[]string](#[]string), [map[string]](#map[string])</div> 1274 VolumeRemove removes a volume on a remote host 1275 ### <a name="VolumesPrune"></a>func VolumesPrune 1276 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1277 1278 method VolumesPrune() [[]string](#[]string), [[]string](#[]string)</div> 1279 VolumesPrune removes unused volumes on the host 1280 ### <a name="WaitContainer"></a>func WaitContainer 1281 <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> 1282 1283 method WaitContainer(name: [string](https://godoc.org/builtin#string), interval: [int](https://godoc.org/builtin#int)) [int](https://godoc.org/builtin#int)</div> 1284 WaitContainer takes the name or ID of a container and waits the given interval in milliseconds until the container 1285 stops. Upon stopping, the return code of the container is returned. If the container container cannot be found by ID 1286 or name, a [ContainerNotFound](#ContainerNotFound) error is returned. 1287 ## Types 1288 ### <a name="AuthConfig"></a>type AuthConfig 1289 1290 1291 1292 username [string](https://godoc.org/builtin#string) 1293 1294 password [string](https://godoc.org/builtin#string) 1295 ### <a name="BuildInfo"></a>type BuildInfo 1296 1297 BuildInfo is used to describe user input for building images 1298 1299 architecture [string](https://godoc.org/builtin#string) 1300 1301 addCapabilities [[]string](#[]string) 1302 1303 additionalTags [[]string](#[]string) 1304 1305 annotations [[]string](#[]string) 1306 1307 buildArgs [map[string]](#map[string]) 1308 1309 buildOptions [BuildOptions](#BuildOptions) 1310 1311 cniConfigDir [string](https://godoc.org/builtin#string) 1312 1313 cniPluginDir [string](https://godoc.org/builtin#string) 1314 1315 compression [string](https://godoc.org/builtin#string) 1316 1317 contextDir [string](https://godoc.org/builtin#string) 1318 1319 defaultsMountFilePath [string](https://godoc.org/builtin#string) 1320 1321 devices [[]string](#[]string) 1322 1323 dockerfiles [[]string](#[]string) 1324 1325 dropCapabilities [[]string](#[]string) 1326 1327 err [string](https://godoc.org/builtin#string) 1328 1329 forceRmIntermediateCtrs [bool](https://godoc.org/builtin#bool) 1330 1331 iidfile [string](https://godoc.org/builtin#string) 1332 1333 label [[]string](#[]string) 1334 1335 layers [bool](https://godoc.org/builtin#bool) 1336 1337 nocache [bool](https://godoc.org/builtin#bool) 1338 1339 os [string](https://godoc.org/builtin#string) 1340 1341 out [string](https://godoc.org/builtin#string) 1342 1343 output [string](https://godoc.org/builtin#string) 1344 1345 outputFormat [string](https://godoc.org/builtin#string) 1346 1347 pullPolicy [string](https://godoc.org/builtin#string) 1348 1349 quiet [bool](https://godoc.org/builtin#bool) 1350 1351 remoteIntermediateCtrs [bool](https://godoc.org/builtin#bool) 1352 1353 reportWriter [string](https://godoc.org/builtin#string) 1354 1355 runtimeArgs [[]string](#[]string) 1356 1357 signBy [string](https://godoc.org/builtin#string) 1358 1359 squash [bool](https://godoc.org/builtin#bool) 1360 1361 target [string](https://godoc.org/builtin#string) 1362 1363 transientMounts [[]string](#[]string) 1364 ### <a name="BuildOptions"></a>type BuildOptions 1365 1366 BuildOptions are are used to describe describe physical attributes of the build 1367 1368 addHosts [[]string](#[]string) 1369 1370 cgroupParent [string](https://godoc.org/builtin#string) 1371 1372 cpuPeriod [int](https://godoc.org/builtin#int) 1373 1374 cpuQuota [int](https://godoc.org/builtin#int) 1375 1376 cpuShares [int](https://godoc.org/builtin#int) 1377 1378 cpusetCpus [string](https://godoc.org/builtin#string) 1379 1380 cpusetMems [string](https://godoc.org/builtin#string) 1381 1382 memory [int](https://godoc.org/builtin#int) 1383 1384 memorySwap [int](https://godoc.org/builtin#int) 1385 1386 shmSize [string](https://godoc.org/builtin#string) 1387 1388 ulimit [[]string](#[]string) 1389 1390 volume [[]string](#[]string) 1391 ### <a name="Container"></a>type Container 1392 1393 1394 1395 id [string](https://godoc.org/builtin#string) 1396 1397 image [string](https://godoc.org/builtin#string) 1398 1399 imageid [string](https://godoc.org/builtin#string) 1400 1401 command [[]string](#[]string) 1402 1403 createdat [string](https://godoc.org/builtin#string) 1404 1405 runningfor [string](https://godoc.org/builtin#string) 1406 1407 status [string](https://godoc.org/builtin#string) 1408 1409 ports [ContainerPortMappings](#ContainerPortMappings) 1410 1411 rootfssize [int](https://godoc.org/builtin#int) 1412 1413 rwsize [int](https://godoc.org/builtin#int) 1414 1415 names [string](https://godoc.org/builtin#string) 1416 1417 labels [map[string]](#map[string]) 1418 1419 mounts [ContainerMount](#ContainerMount) 1420 1421 containerrunning [bool](https://godoc.org/builtin#bool) 1422 1423 namespaces [ContainerNameSpace](#ContainerNameSpace) 1424 ### <a name="ContainerChanges"></a>type ContainerChanges 1425 1426 ContainerChanges describes the return struct for ListContainerChanges 1427 1428 changed [[]string](#[]string) 1429 1430 added [[]string](#[]string) 1431 1432 deleted [[]string](#[]string) 1433 ### <a name="ContainerMount"></a>type ContainerMount 1434 1435 ContainerMount describes the struct for mounts in a container 1436 1437 destination [string](https://godoc.org/builtin#string) 1438 1439 type [string](https://godoc.org/builtin#string) 1440 1441 source [string](https://godoc.org/builtin#string) 1442 1443 options [[]string](#[]string) 1444 ### <a name="ContainerNameSpace"></a>type ContainerNameSpace 1445 1446 ContainerNamespace describes the namespace structure for an existing container 1447 1448 user [string](https://godoc.org/builtin#string) 1449 1450 uts [string](https://godoc.org/builtin#string) 1451 1452 pidns [string](https://godoc.org/builtin#string) 1453 1454 pid [string](https://godoc.org/builtin#string) 1455 1456 cgroup [string](https://godoc.org/builtin#string) 1457 1458 net [string](https://godoc.org/builtin#string) 1459 1460 mnt [string](https://godoc.org/builtin#string) 1461 1462 ipc [string](https://godoc.org/builtin#string) 1463 ### <a name="ContainerPortMappings"></a>type ContainerPortMappings 1464 1465 ContainerPortMappings describes the struct for portmappings in an existing container 1466 1467 host_port [string](https://godoc.org/builtin#string) 1468 1469 host_ip [string](https://godoc.org/builtin#string) 1470 1471 protocol [string](https://godoc.org/builtin#string) 1472 1473 container_port [string](https://godoc.org/builtin#string) 1474 ### <a name="ContainerStats"></a>type ContainerStats 1475 1476 ContainerStats is the return struct for the stats of a container 1477 1478 id [string](https://godoc.org/builtin#string) 1479 1480 name [string](https://godoc.org/builtin#string) 1481 1482 cpu [float](https://golang.org/src/builtin/builtin.go#L58) 1483 1484 cpu_nano [int](https://godoc.org/builtin#int) 1485 1486 system_nano [int](https://godoc.org/builtin#int) 1487 1488 mem_usage [int](https://godoc.org/builtin#int) 1489 1490 mem_limit [int](https://godoc.org/builtin#int) 1491 1492 mem_perc [float](https://golang.org/src/builtin/builtin.go#L58) 1493 1494 net_input [int](https://godoc.org/builtin#int) 1495 1496 net_output [int](https://godoc.org/builtin#int) 1497 1498 block_output [int](https://godoc.org/builtin#int) 1499 1500 block_input [int](https://godoc.org/builtin#int) 1501 1502 pids [int](https://godoc.org/builtin#int) 1503 ### <a name="Create"></a>type Create 1504 1505 Create is an input structure for creating containers. 1506 args[0] is the image name or id 1507 args[1-] are the new commands if changed 1508 1509 args [[]string](#[]string) 1510 1511 addHost [?[]string](#?[]string) 1512 1513 annotation [?[]string](#?[]string) 1514 1515 attach [?[]string](#?[]string) 1516 1517 blkioWeight [?string](#?string) 1518 1519 blkioWeightDevice [?[]string](#?[]string) 1520 1521 capAdd [?[]string](#?[]string) 1522 1523 capDrop [?[]string](#?[]string) 1524 1525 cgroupParent [?string](#?string) 1526 1527 cidFile [?string](#?string) 1528 1529 conmonPidfile [?string](#?string) 1530 1531 command [?[]string](#?[]string) 1532 1533 cpuPeriod [?int](#?int) 1534 1535 cpuQuota [?int](#?int) 1536 1537 cpuRtPeriod [?int](#?int) 1538 1539 cpuRtRuntime [?int](#?int) 1540 1541 cpuShares [?int](#?int) 1542 1543 cpus [?float](#?float) 1544 1545 cpuSetCpus [?string](#?string) 1546 1547 cpuSetMems [?string](#?string) 1548 1549 detach [?bool](#?bool) 1550 1551 detachKeys [?string](#?string) 1552 1553 device [?[]string](#?[]string) 1554 1555 deviceReadBps [?[]string](#?[]string) 1556 1557 deviceReadIops [?[]string](#?[]string) 1558 1559 deviceWriteBps [?[]string](#?[]string) 1560 1561 deviceWriteIops [?[]string](#?[]string) 1562 1563 dns [?[]string](#?[]string) 1564 1565 dnsOpt [?[]string](#?[]string) 1566 1567 dnsSearch [?[]string](#?[]string) 1568 1569 dnsServers [?[]string](#?[]string) 1570 1571 entrypoint [?string](#?string) 1572 1573 env [?[]string](#?[]string) 1574 1575 envFile [?[]string](#?[]string) 1576 1577 expose [?[]string](#?[]string) 1578 1579 gidmap [?[]string](#?[]string) 1580 1581 groupadd [?[]string](#?[]string) 1582 1583 healthcheckCommand [?string](#?string) 1584 1585 healthcheckInterval [?string](#?string) 1586 1587 healthcheckRetries [?int](#?int) 1588 1589 healthcheckStartPeriod [?string](#?string) 1590 1591 healthcheckTimeout [?string](#?string) 1592 1593 hostname [?string](#?string) 1594 1595 imageVolume [?string](#?string) 1596 1597 init [?bool](#?bool) 1598 1599 initPath [?string](#?string) 1600 1601 interactive [?bool](#?bool) 1602 1603 ip [?string](#?string) 1604 1605 ipc [?string](#?string) 1606 1607 kernelMemory [?string](#?string) 1608 1609 label [?[]string](#?[]string) 1610 1611 labelFile [?[]string](#?[]string) 1612 1613 logDriver [?string](#?string) 1614 1615 logOpt [?[]string](#?[]string) 1616 1617 macAddress [?string](#?string) 1618 1619 memory [?string](#?string) 1620 1621 memoryReservation [?string](#?string) 1622 1623 memorySwap [?string](#?string) 1624 1625 memorySwappiness [?int](#?int) 1626 1627 name [?string](#?string) 1628 1629 network [?string](#?string) 1630 1631 noHosts [?bool](#?bool) 1632 1633 oomKillDisable [?bool](#?bool) 1634 1635 oomScoreAdj [?int](#?int) 1636 1637 overrideArch [?string](#?string) 1638 1639 overrideOS [?string](#?string) 1640 1641 pid [?string](#?string) 1642 1643 pidsLimit [?int](#?int) 1644 1645 pod [?string](#?string) 1646 1647 privileged [?bool](#?bool) 1648 1649 publish [?[]string](#?[]string) 1650 1651 publishAll [?bool](#?bool) 1652 1653 pull [?string](#?string) 1654 1655 quiet [?bool](#?bool) 1656 1657 readonly [?bool](#?bool) 1658 1659 readonlytmpfs [?bool](#?bool) 1660 1661 restart [?string](#?string) 1662 1663 rm [?bool](#?bool) 1664 1665 rootfs [?bool](#?bool) 1666 1667 securityOpt [?[]string](#?[]string) 1668 1669 shmSize [?string](#?string) 1670 1671 stopSignal [?string](#?string) 1672 1673 stopTimeout [?int](#?int) 1674 1675 storageOpt [?[]string](#?[]string) 1676 1677 subuidname [?string](#?string) 1678 1679 subgidname [?string](#?string) 1680 1681 sysctl [?[]string](#?[]string) 1682 1683 systemd [?string](#?string) 1684 1685 tmpfs [?[]string](#?[]string) 1686 1687 tty [?bool](#?bool) 1688 1689 uidmap [?[]string](#?[]string) 1690 1691 ulimit [?[]string](#?[]string) 1692 1693 user [?string](#?string) 1694 1695 userns [?string](#?string) 1696 1697 uts [?string](#?string) 1698 1699 mount [?[]string](#?[]string) 1700 1701 volume [?[]string](#?[]string) 1702 1703 volumesFrom [?[]string](#?[]string) 1704 1705 workDir [?string](#?string) 1706 ### <a name="DiffInfo"></a>type DiffInfo 1707 1708 1709 1710 path [string](https://godoc.org/builtin#string) 1711 1712 changeType [string](https://godoc.org/builtin#string) 1713 ### <a name="Event"></a>type Event 1714 1715 Event describes a libpod struct 1716 1717 id [string](https://godoc.org/builtin#string) 1718 1719 image [string](https://godoc.org/builtin#string) 1720 1721 name [string](https://godoc.org/builtin#string) 1722 1723 status [string](https://godoc.org/builtin#string) 1724 1725 time [string](https://godoc.org/builtin#string) 1726 1727 type [string](https://godoc.org/builtin#string) 1728 ### <a name="ExecOpts"></a>type ExecOpts 1729 1730 1731 1732 name [string](https://godoc.org/builtin#string) 1733 1734 tty [bool](https://godoc.org/builtin#bool) 1735 1736 privileged [bool](https://godoc.org/builtin#bool) 1737 1738 cmd [[]string](#[]string) 1739 1740 user [?string](#?string) 1741 1742 workdir [?string](#?string) 1743 1744 env [?[]string](#?[]string) 1745 1746 detachKeys [?string](#?string) 1747 ### <a name="Image"></a>type Image 1748 1749 1750 1751 id [string](https://godoc.org/builtin#string) 1752 1753 digest [string](https://godoc.org/builtin#string) 1754 1755 digests [[]string](#[]string) 1756 1757 parentId [string](https://godoc.org/builtin#string) 1758 1759 repoTags [[]string](#[]string) 1760 1761 repoDigests [[]string](#[]string) 1762 1763 created [string](https://godoc.org/builtin#string) 1764 1765 size [int](https://godoc.org/builtin#int) 1766 1767 virtualSize [int](https://godoc.org/builtin#int) 1768 1769 containers [int](https://godoc.org/builtin#int) 1770 1771 labels [map[string]](#map[string]) 1772 1773 isParent [bool](https://godoc.org/builtin#bool) 1774 1775 topLayer [string](https://godoc.org/builtin#string) 1776 1777 readOnly [bool](https://godoc.org/builtin#bool) 1778 1779 history [[]string](#[]string) 1780 ### <a name="ImageHistory"></a>type ImageHistory 1781 1782 ImageHistory describes the returned structure from ImageHistory. 1783 1784 id [string](https://godoc.org/builtin#string) 1785 1786 created [string](https://godoc.org/builtin#string) 1787 1788 createdBy [string](https://godoc.org/builtin#string) 1789 1790 tags [[]string](#[]string) 1791 1792 size [int](https://godoc.org/builtin#int) 1793 1794 comment [string](https://godoc.org/builtin#string) 1795 ### <a name="ImageSaveOptions"></a>type ImageSaveOptions 1796 1797 1798 1799 name [string](https://godoc.org/builtin#string) 1800 1801 format [string](https://godoc.org/builtin#string) 1802 1803 output [string](https://godoc.org/builtin#string) 1804 1805 outputType [string](https://godoc.org/builtin#string) 1806 1807 moreTags [[]string](#[]string) 1808 1809 quiet [bool](https://godoc.org/builtin#bool) 1810 1811 compress [bool](https://godoc.org/builtin#bool) 1812 ### <a name="ImageSearchFilter"></a>type ImageSearchFilter 1813 1814 1815 1816 is_official [?bool](#?bool) 1817 1818 is_automated [?bool](#?bool) 1819 1820 star_count [int](https://godoc.org/builtin#int) 1821 ### <a name="ImageSearchResult"></a>type ImageSearchResult 1822 1823 Represents a single search result from SearchImages 1824 1825 description [string](https://godoc.org/builtin#string) 1826 1827 is_official [bool](https://godoc.org/builtin#bool) 1828 1829 is_automated [bool](https://godoc.org/builtin#bool) 1830 1831 registry [string](https://godoc.org/builtin#string) 1832 1833 name [string](https://godoc.org/builtin#string) 1834 1835 star_count [int](https://godoc.org/builtin#int) 1836 ### <a name="InfoDistribution"></a>type InfoDistribution 1837 1838 InfoDistribution describes the host's distribution 1839 1840 distribution [string](https://godoc.org/builtin#string) 1841 1842 version [string](https://godoc.org/builtin#string) 1843 ### <a name="InfoGraphStatus"></a>type InfoGraphStatus 1844 1845 InfoGraphStatus describes the detailed status of the storage driver 1846 1847 backing_filesystem [string](https://godoc.org/builtin#string) 1848 1849 native_overlay_diff [string](https://godoc.org/builtin#string) 1850 1851 supports_d_type [string](https://godoc.org/builtin#string) 1852 ### <a name="InfoHost"></a>type InfoHost 1853 1854 InfoHost describes the host stats portion of PodmanInfo 1855 1856 buildah_version [string](https://godoc.org/builtin#string) 1857 1858 distribution [InfoDistribution](#InfoDistribution) 1859 1860 mem_free [int](https://godoc.org/builtin#int) 1861 1862 mem_total [int](https://godoc.org/builtin#int) 1863 1864 swap_free [int](https://godoc.org/builtin#int) 1865 1866 swap_total [int](https://godoc.org/builtin#int) 1867 1868 arch [string](https://godoc.org/builtin#string) 1869 1870 cpus [int](https://godoc.org/builtin#int) 1871 1872 hostname [string](https://godoc.org/builtin#string) 1873 1874 kernel [string](https://godoc.org/builtin#string) 1875 1876 os [string](https://godoc.org/builtin#string) 1877 1878 uptime [string](https://godoc.org/builtin#string) 1879 1880 eventlogger [string](https://godoc.org/builtin#string) 1881 ### <a name="InfoPodmanBinary"></a>type InfoPodmanBinary 1882 1883 InfoPodman provides details on the Podman binary 1884 1885 compiler [string](https://godoc.org/builtin#string) 1886 1887 go_version [string](https://godoc.org/builtin#string) 1888 1889 podman_version [string](https://godoc.org/builtin#string) 1890 1891 git_commit [string](https://godoc.org/builtin#string) 1892 ### <a name="InfoRegistry"></a>type InfoRegistry 1893 1894 InfoRegistry describes the host's registry information 1895 1896 search [[]string](#[]string) 1897 1898 insecure [[]string](#[]string) 1899 1900 blocked [[]string](#[]string) 1901 ### <a name="InfoStore"></a>type InfoStore 1902 1903 InfoStore describes the host's storage information 1904 1905 containers [int](https://godoc.org/builtin#int) 1906 1907 images [int](https://godoc.org/builtin#int) 1908 1909 graph_driver_name [string](https://godoc.org/builtin#string) 1910 1911 graph_driver_options [string](https://godoc.org/builtin#string) 1912 1913 graph_root [string](https://godoc.org/builtin#string) 1914 1915 graph_status [InfoGraphStatus](#InfoGraphStatus) 1916 1917 run_root [string](https://godoc.org/builtin#string) 1918 ### <a name="KubePodService"></a>type KubePodService 1919 1920 1921 1922 pod [string](https://godoc.org/builtin#string) 1923 1924 service [string](https://godoc.org/builtin#string) 1925 ### <a name="ListPodContainerInfo"></a>type ListPodContainerInfo 1926 1927 ListPodContainerInfo is a returned struct for describing containers 1928 in a pod. 1929 1930 name [string](https://godoc.org/builtin#string) 1931 1932 id [string](https://godoc.org/builtin#string) 1933 1934 status [string](https://godoc.org/builtin#string) 1935 ### <a name="ListPodData"></a>type ListPodData 1936 1937 ListPodData is the returned struct for an individual pod 1938 1939 id [string](https://godoc.org/builtin#string) 1940 1941 name [string](https://godoc.org/builtin#string) 1942 1943 createdat [string](https://godoc.org/builtin#string) 1944 1945 cgroup [string](https://godoc.org/builtin#string) 1946 1947 status [string](https://godoc.org/builtin#string) 1948 1949 labels [map[string]](#map[string]) 1950 1951 numberofcontainers [string](https://godoc.org/builtin#string) 1952 1953 containersinfo [ListPodContainerInfo](#ListPodContainerInfo) 1954 ### <a name="LogLine"></a>type LogLine 1955 1956 1957 1958 device [string](https://godoc.org/builtin#string) 1959 1960 parseLogType [string](https://godoc.org/builtin#string) 1961 1962 time [string](https://godoc.org/builtin#string) 1963 1964 msg [string](https://godoc.org/builtin#string) 1965 1966 cid [string](https://godoc.org/builtin#string) 1967 ### <a name="MoreResponse"></a>type MoreResponse 1968 1969 MoreResponse is a struct for when responses from varlink requires longer output 1970 1971 logs [[]string](#[]string) 1972 1973 id [string](https://godoc.org/builtin#string) 1974 ### <a name="NotImplemented"></a>type NotImplemented 1975 1976 1977 1978 comment [string](https://godoc.org/builtin#string) 1979 ### <a name="PodContainerErrorData"></a>type PodContainerErrorData 1980 1981 1982 1983 containerid [string](https://godoc.org/builtin#string) 1984 1985 reason [string](https://godoc.org/builtin#string) 1986 ### <a name="PodCreate"></a>type PodCreate 1987 1988 PodCreate is an input structure for creating pods. 1989 It emulates options to podman pod create. The infraCommand and 1990 infraImage options are currently NotSupported. 1991 1992 name [string](https://godoc.org/builtin#string) 1993 1994 cgroupParent [string](https://godoc.org/builtin#string) 1995 1996 labels [map[string]](#map[string]) 1997 1998 share [[]string](#[]string) 1999 2000 infra [bool](https://godoc.org/builtin#bool) 2001 2002 infraCommand [string](https://godoc.org/builtin#string) 2003 2004 infraImage [string](https://godoc.org/builtin#string) 2005 2006 publish [[]string](#[]string) 2007 ### <a name="PodmanInfo"></a>type PodmanInfo 2008 2009 PodmanInfo describes the Podman host and build 2010 2011 host [InfoHost](#InfoHost) 2012 2013 registries [InfoRegistry](#InfoRegistry) 2014 2015 store [InfoStore](#InfoStore) 2016 2017 podman [InfoPodmanBinary](#InfoPodmanBinary) 2018 ### <a name="PsContainer"></a>type PsContainer 2019 2020 2021 2022 id [string](https://godoc.org/builtin#string) 2023 2024 image [string](https://godoc.org/builtin#string) 2025 2026 command [string](https://godoc.org/builtin#string) 2027 2028 created [string](https://godoc.org/builtin#string) 2029 2030 ports [string](https://godoc.org/builtin#string) 2031 2032 names [string](https://godoc.org/builtin#string) 2033 2034 isInfra [bool](https://godoc.org/builtin#bool) 2035 2036 status [string](https://godoc.org/builtin#string) 2037 2038 state [string](https://godoc.org/builtin#string) 2039 2040 pidNum [int](https://godoc.org/builtin#int) 2041 2042 rootFsSize [int](https://godoc.org/builtin#int) 2043 2044 rwSize [int](https://godoc.org/builtin#int) 2045 2046 pod [string](https://godoc.org/builtin#string) 2047 2048 createdAt [string](https://godoc.org/builtin#string) 2049 2050 exitedAt [string](https://godoc.org/builtin#string) 2051 2052 startedAt [string](https://godoc.org/builtin#string) 2053 2054 labels [map[string]](#map[string]) 2055 2056 nsPid [string](https://godoc.org/builtin#string) 2057 2058 cgroup [string](https://godoc.org/builtin#string) 2059 2060 ipc [string](https://godoc.org/builtin#string) 2061 2062 mnt [string](https://godoc.org/builtin#string) 2063 2064 net [string](https://godoc.org/builtin#string) 2065 2066 pidNs [string](https://godoc.org/builtin#string) 2067 2068 user [string](https://godoc.org/builtin#string) 2069 2070 uts [string](https://godoc.org/builtin#string) 2071 2072 mounts [string](https://godoc.org/builtin#string) 2073 ### <a name="PsOpts"></a>type PsOpts 2074 2075 2076 2077 all [bool](https://godoc.org/builtin#bool) 2078 2079 filters [?[]string](#?[]string) 2080 2081 last [?int](#?int) 2082 2083 latest [?bool](#?bool) 2084 2085 noTrunc [?bool](#?bool) 2086 2087 pod [?bool](#?bool) 2088 2089 quiet [?bool](#?bool) 2090 2091 size [?bool](#?bool) 2092 2093 sort [?string](#?string) 2094 2095 sync [?bool](#?bool) 2096 ### <a name="RemoveImageResponse"></a>type RemoveImageResponse 2097 2098 2099 2100 untagged [[]string](#[]string) 2101 2102 deleted [string](https://godoc.org/builtin#string) 2103 ### <a name="Runlabel"></a>type Runlabel 2104 2105 Runlabel describes the required input for container runlabel 2106 2107 image [string](https://godoc.org/builtin#string) 2108 2109 authfile [string](https://godoc.org/builtin#string) 2110 2111 display [bool](https://godoc.org/builtin#bool) 2112 2113 name [string](https://godoc.org/builtin#string) 2114 2115 pull [bool](https://godoc.org/builtin#bool) 2116 2117 label [string](https://godoc.org/builtin#string) 2118 2119 extraArgs [[]string](#[]string) 2120 2121 opts [map[string]](#map[string]) 2122 ### <a name="Sockets"></a>type Sockets 2123 2124 Sockets describes sockets location for a container 2125 2126 container_id [string](https://godoc.org/builtin#string) 2127 2128 io_socket [string](https://godoc.org/builtin#string) 2129 2130 control_socket [string](https://godoc.org/builtin#string) 2131 ### <a name="StringResponse"></a>type StringResponse 2132 2133 2134 2135 message [string](https://godoc.org/builtin#string) 2136 ### <a name="Volume"></a>type Volume 2137 2138 2139 2140 name [string](https://godoc.org/builtin#string) 2141 2142 labels [map[string]](#map[string]) 2143 2144 mountPoint [string](https://godoc.org/builtin#string) 2145 2146 driver [string](https://godoc.org/builtin#string) 2147 2148 options [map[string]](#map[string]) 2149 ### <a name="VolumeCreateOpts"></a>type VolumeCreateOpts 2150 2151 2152 2153 volumeName [string](https://godoc.org/builtin#string) 2154 2155 driver [string](https://godoc.org/builtin#string) 2156 2157 labels [map[string]](#map[string]) 2158 2159 options [map[string]](#map[string]) 2160 ### <a name="VolumeRemoveOpts"></a>type VolumeRemoveOpts 2161 2162 2163 2164 volumes [[]string](#[]string) 2165 2166 all [bool](https://godoc.org/builtin#bool) 2167 2168 force [bool](https://godoc.org/builtin#bool) 2169 ## Errors 2170 ### <a name="ContainerNotFound"></a>type ContainerNotFound 2171 2172 ContainerNotFound means the container could not be found by the provided name or ID in local storage. 2173 ### <a name="ErrCtrStopped"></a>type ErrCtrStopped 2174 2175 Container is already stopped 2176 ### <a name="ErrRequiresCgroupsV2ForRootless"></a>type ErrRequiresCgroupsV2ForRootless 2177 2178 This function requires CGroupsV2 to run in rootless mode. 2179 ### <a name="ErrorOccurred"></a>type ErrorOccurred 2180 2181 ErrorOccurred is a generic error for an error that occurs during the execution. The actual error message 2182 is includes as part of the error's text. 2183 ### <a name="ImageNotFound"></a>type ImageNotFound 2184 2185 ImageNotFound means the image could not be found by the provided name or ID in local storage. 2186 ### <a name="InvalidState"></a>type InvalidState 2187 2188 InvalidState indicates that a container or pod was in an improper state for the requested operation 2189 ### <a name="NoContainerRunning"></a>type NoContainerRunning 2190 2191 NoContainerRunning means none of the containers requested are running in a command that requires a running container. 2192 ### <a name="NoContainersInPod"></a>type NoContainersInPod 2193 2194 NoContainersInPod means a pod has no containers on which to perform the operation. It contains 2195 the pod ID. 2196 ### <a name="PodContainerError"></a>type PodContainerError 2197 2198 PodContainerError means a container associated with a pod failed to perform an operation. It contains 2199 a container ID of the container that failed. 2200 ### <a name="PodNotFound"></a>type PodNotFound 2201 2202 PodNotFound means the pod could not be found by the provided name or ID in local storage. 2203 ### <a name="RuntimeError"></a>type RuntimeError 2204 2205 RuntimeErrors generally means a runtime could not be found or gotten. 2206 ### <a name="VolumeNotFound"></a>type VolumeNotFound 2207 2208 VolumeNotFound means the volume could not be found by the name or ID in local storage. 2209 ### <a name="WantsMoreRequired"></a>type WantsMoreRequired 2210 2211 The Podman endpoint requires that you use a streaming connection.