Module models Copy item path Source AccessMode Address AuthConfig AuthConfig contains authorization information for connecting to a Registry AuthReport AuthReport describes the response for authentication check AuthenticateOkBody AuthenticateOKBody authenticate o k body AutoUserNsOptions BindOptions CapacityRange CapacityRange describes the minimum and maximum capacity a volume should be
created with ClusterVolume ClusterVolume contains options and information specific to, and only present
on, Swarm CSI cluster volumes. ClusterVolumeSpec ComponentVersion Config It should hold only portable information about the container.
Here, “portable” means “independent from the host we are running on”.
Non-portable information should appear in HostConfig.
All fields added to this struct must be marked omitempty to keep getting
predictable hashes from the old v1Compatibility configuration. ConfigReference ConfigReference specifies the source which provides a network’s configuration Container ContainerBasicConfig ContainerCgroupConfig ContainerCgroupConfig contains configuration information about a container’s
cgroups. ContainerChangeResponseItem ContainerChangeResponseItem change item in response to ContainerChanges operation ContainerCreateResponse ContainerCreateResponse is the response struct for creating a container ContainerExecControlParam ContainerExecLibpodControlParam ContainerHealthCheckConfig ContainerHealthCheckConfig describes a container healthcheck with attributes
like command, retries, interval, start period, and timeout. ContainerJson ContainerJSON is newly used struct along with MountPoint ContainerNetworkConfig ContainerNetworkConfig contains information on a container’s network
configuration. ContainerNode ContainerNode stores information about the node that a container
is running on. It’s only used by the Docker Swarm standalone API ContainerResourceConfig ContainerSecurityConfig ContainerSecurityConfig is a container’s security features, including
SELinux, Apparmor, and Seccomp. ContainerSize ContainerSize holds the size of the container’s root filesystem and top
read-write layer. ContainerState ContainerState stores container’s running state
it’s part of ContainerJSONBase and will return by “inspect” command ContainerStats ContainerStats contains the statistics information for a running container ContainerStorageConfig ContainerStorageConfig contains information on the storage configuration of a
container. ContainerTopOkBody ContainerTopOKBody OK response to ContainerTop operation ContainerUpdateOkBody ContainerUpdateOKBody OK response to ContainerUpdate operation ContainerWaitResponse Wait container ContainerWaitResponseErrorInlineItem ContainersPruneReport ContainersPruneReportLibpod CreateContainerConfig CreateContainerConfig used when compatible endpoint creates a container CreateOptions Volume configuration CreateResponse OK response to ContainerCreate operation DeviceMapping DeviceRequest Used by GPU device drivers. Driver DriverData DriverData handles the data for a storage driver EndpointIpamConfig EndpointIPAMConfig represents IPAM configurations for the endpoint EndpointResource EndpointResource contains network resources allocated and used for a container in a network EndpointSettings EndpointSettings stores the network endpoint details ErrorModel ErrorModel is used in remote connections with podman ErrorResponse ExecStartControlParam ExecStartLibpodControlParam GraphDriverData GraphDriverData Information about the storage driver used to store the container’s and
image’s filesystem. Health Health stores information about the container’s healthcheck results HealthCheckLog HealthCheckLog describes the results of a single healthcheck HealthCheckResults HealthCheckResults describes the results/logs from a healthcheck HealthConfig HealthcheckResult HealthcheckResult stores information about a single run of a healthcheck probe History HistoryResponse HistoryResponse provides details on image layers HistoryResponseItem HistoryResponseItem individual image layer information in response to ImageHistory operation HostConfig Here, “non-portable” means “dependent of the host we are running on”.
Portable information should appear in Config. IdMap IDMap contains a single entry for user namespace range remapping. An array
of IDMap entries represents the structure that will be provided to the Linux
kernel for creating a user namespace. IdMappingOptions IDMappingOptions are used for specifying how ID mapping should be set up for
a layer or container. IdResponse IDResponse Response to an API call that returns just an Id ImageBuild200Response OK (As of version 1.xx) ImageBuildLibpod200Response OK (As of version 1.xx) ImageConfig ImageData ImageDeleteResponseInlineItem ImageDeleteResponseItem ImageDeleteResponseItem image delete response item ImageImportReport ImageInspect ImageLoadReport ImageMetadata ImageMetadata contains engine-local data about the image ImageSummary ImageSummary image summary ImageTreeReport ImageTreeReport provides results from ImageEngine.Tree() ImageVolume ImageVolume is a volume based on a container image. The container image is
first mounted on the host and is then bind-mounted into the container. An
ImageVolume is always mounted read-only. Info Info contains information about the Volume as a whole as provided by
the CSI storage plugin. InspectAdditionalNetwork InspectAdditionalNetwork holds information about non-default networks the
container has been connected to.
As with InspectNetworkSettings, many fields are unused and maintained only
for compatibility with Docker. InspectBlkioThrottleDevice InspectBlkioThrottleDevice holds information about a speed cap for a device
node. This cap applies to a specific operation (read, write, etc) on the given
node. InspectBlkioWeightDevice InspectBlkioWeightDevice holds information about the relative weight
of an individual device node. Weights are used in the I/O scheduler to give
relative priority to some accesses. InspectContainerConfig InspectContainerConfig holds further data about how a container was initially
configured. InspectContainerData InspectContainerData provides a detailed record of a container’s configuration
and state as viewed by Libpod.
Large portions of this structure are defined such that the output is
compatible with docker inspect JSON, but additional fields have been added
as required to share information not in the original output. InspectContainerHostConfig nolint:revive,stylecheck // Field names are fixed for compatibility and cannot be changed. InspectContainerState InspectContainerState provides a detailed record of a container’s current
state. It is returned as part of InspectContainerData.
As with InspectContainerData, many portions of this struct are matched to
Docker, but here we see more fields that are unused (nonsensical in the
context of Libpod). InspectDevice InspectExecProcess InspectExecProcess contains information about the process in a given exec
session. InspectExecSession InspectHostPort InspectHostPort provides information on a port on the host that a container’s
port is bound to. InspectIdMappings InspectLogConfig InspectLogConfig holds information about a container’s configured log driver InspectMount InspectMount provides a record of a single mount in a container. It contains
fields for both named and normal volumes. Only user-specified volumes will be
included, and tmpfs volumes are not included even if the user specified them. InspectNetworkSettings InspectNetworkSettings holds information about the network settings of the
container.
Many fields are maintained only for compatibility with docker inspect and
are unused within Libpod. InspectPodContainerInfo InspectPodData InspectPodData contains detailed information on a pod’s configuration and
state. It is used as the output of Inspect on pods. InspectPodInfraConfig InspectPodInfraConfig contains the configuration of the pod’s infra
container. InspectRestartPolicy InspectSecret InspectSecret contains information on secrets mounted inside the container InspectUlimit IpNet Ipam IPAM represents IP Address Management IpamConfig IPAMConfig represents IPAM configurations LeaseRange LibpodContainersRmReport LibpodImageSummary LibpodImagesPullReport LibpodImagesRemoveReport LibpodImagesRemoveReport is the return type for image removal via the rest
api. LinuxBlockIo LinuxBlockIO for Linux cgroup ‘blkio’ resource management LinuxBlockIoDevice LinuxBlockIODevice holds major:minor format supported in blkio cgroup LinuxCpu LinuxCPU for Linux cgroup ‘cpu’ resource management LinuxDevice LinuxDevice represents the mknod information for a Linux special device file LinuxDeviceCgroup LinuxDeviceCgroup represents a device rule for the devices specified to
the device controller LinuxHugepageLimit LinuxHugepageLimit structure corresponds to limiting kernel hugepages LinuxIdMapping LinuxIDMapping specifies UID/GID mappings LinuxInterfacePriority LinuxInterfacePriority for network interfaces LinuxMemory LinuxMemory for Linux cgroup ‘memory’ resource management LinuxNetwork LinuxNetwork identification and priority configuration LinuxPersonality LinuxPersonality represents the Linux personality syscall input LinuxPids LinuxPids for Linux cgroup ‘pids’ resource management (Linux 4.3) LinuxRdma LinuxRdma for Linux cgroup ‘rdma’ resource management (Linux 4.11) LinuxResources LinuxResources has container runtime resource constraints LinuxThrottleDevice LinuxThrottleDevice struct holds a major:minor rate_per_second pair LinuxWeightDevice LinuxWeightDevice struct holds a major:minor weight pair for weightDevice ListContainer ListContainer describes a container suitable for listing ListContainerNamespaces ListContainerNamespaces contains the identifiers of the container’s Linux namespaces ListPodContainer ListPodsReport ListResponse Volume list response LogConfig LogConfigLibpod LogConfig describes the logging characteristics for a container ManifestAddOptions ManifestAddOptions provides model for adding digests to manifest list ManifestAnnotateOptions ManifestAnnotateOptions provides model for annotating manifest list ManifestModifyOptions swagger 2.0 does not support oneOf for schema validation. ManifestModifyReport ManifestModifyReport provides the model for removed digests and changed manifest ManifestPushReport ManifestPushReport provides the model for the pushed manifest ManifestRemoveReport ManifestRemoveReport provides the model for the removed manifest Meta Mount MountPoint This is used for reporting the mountpoints in use by a container. NamedVolume NamedVolume holds information about a named volume that will be mounted into
the container. Namespace Namespace describes the namespace NetOptions NetOptions reflect the shared network options between
pods and containers Network NetworkConnect NetworkConnect represents the data to be used to connect a container to the network NetworkConnectOptions NetworkConnectOptions describes options for connecting
a container to a network NetworkCreate NetworkCreate is the expected body of the “create network” http request message NetworkCreate201Response network created NetworkCreateLibpod Network create NetworkCreateRequest NetworkDisconnect NetworkDisconnect represents the data to be used to disconnect a container from the network NetworkPrune200Response OK NetworkPruneReport NetworkPruneReport containers the name of network and an error
associated in its pruning (removal) NetworkResource NetworkResource is the body of the “get network” http response message NetworkRmReport NetworkRmReport describes the results of network removal NetworkSettings NetworkSettings exposes the network settings in the api NetworkUpdateOptions NetworkUpdateOptions describes options to update a network NetworkingConfig NetworkingConfig represents the container’s networking configuration for each of its interfaces
Carries the networking configs specified in the docker run and docker network connect commands NoSuchSecret No such secret OverlayVolume OverlayVolume holds information about an overlay volume that will be mounted into
the container. PeerInfo PeerInfo represents one peer of an overlay network PerNetworkOptions Platform PlayKubePod PlayKubePod represents a single pod and associated containers created by play kube PlayKubeReport PlayKubeVolume PlaySecret Plugin Plugin A plugin for the Engine API PluginConfig PluginConfigArgs PluginConfigArgs plugin config args PluginConfigInterface PluginConfigInterface The interface between Docker and the plugin PluginConfigLinux PluginConfigLinux plugin config linux PluginConfigNetwork PluginConfigNetwork plugin config network PluginConfigRootfs PluginConfigRootfs plugin config rootfs PluginConfigUser PluginConfigUser plugin config user PluginDevice PluginDevice plugin device PluginEnv PluginEnv plugin env PluginInterfaceType PluginInterfaceType plugin interface type PluginMount PluginMount plugin mount PluginSettings PodBasicConfig PodCgroupConfig This will be expanded in future updates to pods. PodCreateOptions The JSON tags below are made to match the respective field in ContainerCreateOptions for the purpose of mapping. PodKillReport PodNetworkConfig PodPauseReport PodPruneReport PodResourceConfig PodRestartReport PodRmReport PodSecurityConfig PodSpecGenerator PodSpecGenerator describes options to create a pod PodStartReport PodStatsReport PodStopReport PodStorageConfig PodTopOkBody PodUnpauseReport Port Port An open port on a container PortBinding PortBinding represents a binding between a Host IP address and a Host Port PortMapping PosixRlimit POSIXRlimit type and restrictions PruneReport PublishStatus PublishStatus represents the status of the volume as published to an
individual node RegistrySearchResponse Registry Search Resources Resources contains container’s resources (cgroups config, ulimits…) RestartPolicy RootFs Schema2HealthConfig Schema2HealthConfig is a HealthConfig, which holds configuration settings
for the HEALTHCHECK feature, from docker/docker/api/types/container. Schema2ListPublic This is publicly visible as c/image/manifest.Schema2List.
Internal users should usually use Schema2List instead. Schema2ManifestDescriptor This is publicly visible as c/image/manifest.Schema2ManifestDescriptor. Schema2PlatformSpec Schema2PlatformSpec describes the platform which a particular manifest is
specialized for.
This is publicly visible as c/image/manifest.Schema2PlatformSpec. ScpReport Secret Secret represents a Swarm Secret value that must be passed to the CSI
storage plugin when operating on this Volume. It represents one key-value
pair of possibly many. SecretCreate SecretCreateReport SecretCreateResponse Secret create response SecretDriverSpec SecretInUse Secret in use SecretInfoReport SecretInfoReportCompat SecretRmReport SecretSpec SecretVersion ServiceInfo ServiceInfo represents service parameters with the list of service’s tasks ServiceUpdateResponse ServiceUpdateResponse service update response SpecGenerator SpecGenerator creates an OCI spec and Libpod configuration options to create
a container based on the given configuration. StartupHealthCheck Subnet SummaryNetworkSettings SummaryNetworkSettings provides a summary of container’s networks
in /containers/json SystemDfContainerReport SystemDfContainerReport describes a container for use with df SystemDfImageReport SystemDfImageReport describes an image for use with df SystemDfReport SystemDfReport describes the response for df information SystemDfVolumeReport SystemDfVolumeReport describes a volume and its size SystemPruneReport Task Task carries the information about one backend task ThrottleDevice ThrottleDevice is a structure that holds device:rate_per_second pair TmpfsOptions Topology This description is taken verbatim from the CSI Spec: TopologyRequirement TopologyRequirement expresses the user’s requirements for a volume’s
accessible topology. TypeMount TypeMount contains options for using a volume as a Mount-type
volume. Ulimit UpdateEntities UpdateEntities used to wrap the oci resource spec in a swagger model UsageData UsageData Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints. Version Volume Volume volume VolumeConfigResponse VolumeCreate Details for creating a volume VolumeCreateOptions VolumeCreateOptions provides details for creating volumes VolumeOptions VolumeRmReport VolumesPruneReport POST “/volumes/prune” WaitExitError WaitExitError container waiting error, if any WaitResponse OK response to ContainerWait operation WeightDevice WeightDevice is a structure that holds device:weight pair Availability BadParamError ErrorModel is used in remote connections with podman CgroupSpec CgroupnsMode CgroupnsMode represents the cgroup namespace mode of the container ClusterOptions ConflictError ErrorModel is used in remote connections with podman Consistency ContainerAlreadyStartedError ErrorModel is used in remote connections with podman ContainerAlreadyStoppedError ErrorModel is used in remote connections with podman ContainerArchive200Response no error ContainerArchiveLibpod200Response no error ContainerCreateBodyParam CreateContainerConfig used when compatible endpoint creates a container ContainerCreateLibpodCreateParam SpecGenerator creates an OCI spec and Libpod configuration options to create
a container based on the given configuration. ContainerInspectResponse ContainerJSON is newly used struct along with MountPoint ContainerInspectResponseLibpod InspectContainerData provides a detailed record of a container’s configuration
and state as viewed by Libpod.
Large portions of this structure are defined such that the output is
compatible with docker inspect JSON, but additional fields have been added
as required to share information not in the original output. ContainerMountLibpod200Response mounted container ContainerNotFound ErrorModel is used in remote connections with podman ContainerRemoveLibpod Remove Containers ContainerShowMountedLibpod200Response mounted containers ContainerStats200Response no error ContainerTopResponse ContainerTopOKBody OK response to ContainerTop operation ContainerUpdateLibpodResourcesParam UpdateEntities used to wrap the oci resource spec in a swagger model ContainerWaitLibpod200Response Status code ContainersList List Containers ContainersListLibpod List Containers ContainersPrune Prune Containers ContainersPruneLibpod Prune Containers Digest The following is an example of the contents of Digest types: Duration A Duration represents the elapsed time between two instants
as an int64 nanosecond count. The representation limits the
largest representable duration to approximately 290 years. ExecSessionInspect ExecSessionNotFound ErrorModel is used in remote connections with podman FileMode The bits have the same definition on all systems, so that
information about files can be moved from one system
to another portably. Not all bits apply to all systems.
The only required bit is ModeDir for directories. GenerateKubeLibpod200Response Kubernetes YAML file describing pod GenerateSystemdLibpod200Response no error HardwareAddr HealthCheck HealthCheckResults describes the results/logs from a healthcheck HealthCheckOnFailureAction HealthCheckOnFailureAction defines how Podman reacts when a container’s health
status turns unhealthy. ImageBuildInputStreamParam ImageCreate200Response no error ImageCreateInputImageParam ImageDeleteResponse Image Delete ImageExportLibpod200Response no error ImageGet200Response no error ImageGetAll200Response no error ImageGetLibpod200Response no error ImageImportLibpodUploadParam ImageList Image summary for compat API ImageListLibpod Image summary for libpod API ImageLoadLibpodUploadParam ImageLoadRequestParam ImageNotFound ErrorModel is used in remote connections with podman ImagePush200Response no error ImagePushLibpod200Response no error ImagesImportResponseLibpod ImagesLoadResponseLibpod ImagesPruneLibpod Image Prune ImagesPullResponseLibpod ImagesRemoveResponseLibpod LibpodImagesRemoveReport is the return type for image removal via the rest
api. ImagesScpResponseLibpod InfoResponse Info contains information about the Volume as a whole as provided by
the CSI storage plugin. InspectImageResponseLibpod InternalError ErrorModel is used in remote connections with podman IpMask See type IPNet and func ParseCIDR for details. IpcMode Isolation Isolation represents the isolation technology of a container. The supported
values are platform specific KubeApplyLibpod200Response Kubernetes YAML file successfully deployed to cluster KubeApplyLibpodRequestParam LinuxPersonalityDomain LinuxPersonalityFlag ManifestAddLibpodOptionsParam ManifestAddOptions provides model for adding digests to manifest list ManifestCreateLibpodOptionsParam swagger 2.0 does not support oneOf for schema validation. ManifestInspect This is publicly visible as c/image/manifest.Schema2List.
Internal users should usually use Schema2List instead. ManifestModifyLibpodOptionsParam swagger 2.0 does not support oneOf for schema validation. ManifestNotFound ErrorModel is used in remote connections with podman ManifestRemoveOptions ManifestRemoveOptions provides the model for removing digests from a manifest NamespaceMode NetworkConnectRequest NetworkConnect represents the data to be used to connect a container to the network NetworkConnectRequestLibpod NetworkConnectOptions describes options for connecting
a container to a network NetworkCreateLibpodCreateParam Network create NetworkCreateResponse NetworkDisconnectRequest NetworkDisconnect represents the data to be used to disconnect a container from the network NetworkInspectCompat NetworkResource is the body of the “get network” http response message NetworkInspectResponse NetworkListCompat Network list NetworkListLibpod Network list NetworkMode NetworkNotFound ErrorModel is used in remote connections with podman NetworkPruneResponse Network prune NetworkRmResponse Network Delete NetworkUpdateRequestLibpod NetworkUpdateOptions describes options to update a network Ok Success PidMode PlayKubeLibpodRequestParam PlayKubeResponseLibpod PodAlreadyStartedError ErrorModel is used in remote connections with podman PodAlreadyStoppedError ErrorModel is used in remote connections with podman PodCreateLibpod409Response status conflict PodCreateLibpodCreateParam PodSpecGenerator describes options to create a pod PodInspectResponse InspectPodData contains detailed information on a pod’s configuration and
state. It is used as the output of Inspect on pods. PodKillResponse PodNotFound ErrorModel is used in remote connections with podman PodPauseResponse PodPruneResponse PodRestartResponse PodRmResponse PodStartResponse PodStatsResponse Pod Statistics PodStopResponse PodTopResponse PodUnpauseResponse PodsListResponse List pods PortMap PortMap is a collection of PortBinding indexed by Port PortSet PortSet is a collection of structs indexed by Port Propagation PublishState PublishState represents the state of a Volume as it pertains to its
use on a particular Node. PutContainerArchiveLibpodRequestParam PutContainerArchiveRequestParam Scope Scope defines the Scope of a Cluster Volume. This is how many nodes a
Volume can be accessed simultaneously on. SecretCreateCreateParam SecretCreateLibpodRequestParam SecretInspectCompatResponse SecretInspectResponse SecretListCompatResponse Secret list response SecretListResponse Secret list response SharingMode SharingMode defines the Sharing of a Cluster Volume. This is how Tasks using a
Volume at the same time can use it. Signal It implements the os.Signal interface. StrSlice We need to override the json decoder to accept both options. SystemAuthAuthConfigParam AuthConfig contains authorization information for connecting to a Registry SystemAuthResponse AuthReport describes the response for authentication check SystemDiskUsage SystemDfReport describes the response for df information SystemPing200Response Success SystemPruneResponse TreeResponse ImageTreeReport provides results from ImageEngine.Tree() Type TypeBlock Intentionally empty. UsernsMode UtsMode VersionResponse VolumeCreateCreateParam Details for creating a volume VolumeCreateLibpodCreateParam VolumeCreateOptions provides details for creating volumes VolumeCreateResponse VolumeInspect Volume volume VolumeList Volume list response VolumeListLibpod Volume list VolumeNotFound ErrorModel is used in remote connections with podman VolumePruneLibpod Volume Prune VolumePruneResponse POST “/volumes/prune”