diff options
Diffstat (limited to 'API.md')
| -rwxr-xr-x | API.md | 43 |
1 files changed, 40 insertions, 3 deletions
@@ -149,6 +149,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [func RemoveImage(name: string, force: bool) string](#RemoveImage) +[func RemoveImageWithResponse(name: string, force: bool) RemoveImageResponse](#RemoveImageWithResponse) + [func RemovePod(name: string, force: bool) string](#RemovePod) [func Reset() ](#Reset) @@ -183,6 +185,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [func UnpausePod(name: string) string](#UnpausePod) +[func UntagImage(name: string, tag: string) string](#UntagImage) + [func VolumeCreate(options: VolumeCreateOpts) string](#VolumeCreate) [func VolumeRemove(options: VolumeRemoveOpts) []string, map[string]](#VolumeRemove) @@ -233,6 +237,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [type InfoPodmanBinary](#InfoPodmanBinary) +[type InfoRegistry](#InfoRegistry) + [type InfoStore](#InfoStore) [type KubePodService](#KubePodService) @@ -257,6 +263,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [type PsOpts](#PsOpts) +[type RemoveImageResponse](#RemoveImageResponse) + [type Runlabel](#Runlabel) [type Sockets](#Sockets) @@ -1052,6 +1060,13 @@ varlink call -m unix:/run/podman/io.podman/io.podman.RemoveImage '{"name": "regi "image": "426866d6fa419873f97e5cbd320eeb22778244c1dfffa01c944db3114f55772e" } ~~~ +### <a name="RemoveImageWithResponse"></a>func RemoveImageWithResponse +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method RemoveImageWithResponse(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool)) [RemoveImageResponse](#RemoveImageResponse)</div> +RemoveImageWithResponse takes the name or ID of an image as well as a boolean that determines if containers using that image +should be deleted. If the image cannot be found, an [ImageNotFound](#ImageNotFound) error will be returned. The reponse is +in the form of a RemoveImageResponse . ### <a name="RemovePod"></a>func RemovePod <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> @@ -1223,6 +1238,14 @@ $ varlink call -m unix:/run/podman/io.podman/io.podman.UnpausePod '{"name": "foo "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" } ~~~ +### <a name="UntagImage"></a>func UntagImage +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method UntagImage(name: [string](https://godoc.org/builtin#string), tag: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> +UntagImage takes the name or ID of an image in local storage as well as the +tag name to be removed. If the image cannot be found, an +[ImageNotFound](#ImageNotFound) error will be returned; otherwise, the ID of +the image is returned on success. ### <a name="VolumeCreate"></a>func VolumeCreate <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> @@ -1829,6 +1852,15 @@ go_version [string](https://godoc.org/builtin#string) podman_version [string](https://godoc.org/builtin#string) git_commit [string](https://godoc.org/builtin#string) +### <a name="InfoRegistry"></a>type InfoRegistry + +InfoRegistry describes the host's registry information + +search [[]string](#[]string) + +insecure [[]string](#[]string) + +blocked [[]string](#[]string) ### <a name="InfoStore"></a>type InfoStore InfoStore describes the host's storage informatoin @@ -1941,9 +1973,7 @@ PodmanInfo describes the Podman host and build host [InfoHost](#InfoHost) -registries [[]string](#[]string) - -insecure_registries [[]string](#[]string) +registries [InfoRegistry](#InfoRegistry) store [InfoStore](#InfoStore) @@ -2026,6 +2056,13 @@ size [?bool](#?bool) sort [?string](#?string) sync [?bool](#?bool) +### <a name="RemoveImageResponse"></a>type RemoveImageResponse + + + +untagged [[]string](#[]string) + +deleted [string](https://godoc.org/builtin#string) ### <a name="Runlabel"></a>type Runlabel Runlabel describes the required input for container runlabel |