Expand description
Options used for configuring the behavior of certain API endpoints
Structs§
- Changes
Opts - Adjust how filesystem changes inside a container or image are returned.
- Changes
Opts Builder - A builder struct for ChangesOpts.
- Container
Attach Opts - Adjust how to attach to a running container.
- Container
Attach Opts Builder - A builder struct for ContainerAttachOpts.
- Container
Checkpoint Opts - Adjust the way a container is checkpointed.
- Container
Checkpoint Opts Builder - A builder struct for ContainerCheckpointOpts.
- Container
Commit Opts - Adjust the way a new image is created from a container.
- Container
Commit Opts Builder - A builder struct for ContainerCommitOpts.
- Container
Create Opts - Adjust the created container.
- Container
Create Opts Builder - A builder struct for ContainerCreateOpts.
- Container
Delete Opts - Adjust the way a container is deleted.
- Container
Delete Opts Builder - A builder struct for ContainerDeleteOpts.
- Container
List Opts - Adjust the list of returned containers with this options.
- Container
List Opts Builder - A builder struct for ContainerListOpts.
- Container
Logs Opts - Adjust how to attach to a running container.
- Container
Logs Opts Builder - A builder struct for ContainerLogsOpts.
- Container
Prune Opts - Adjust how stopped containers are removed.
- Container
Prune Opts Builder - A builder struct for ContainerPruneOpts.
- Container
Restore Opts - Adjust how a container is restored.
- Container
Restore Opts Builder - A builder struct for ContainerRestoreOpts.
- Container
Stats Opts - Adjust how container stats are reported.
- Container
Stats Opts Builder - A builder struct for ContainerStatsOpts.
- Container
Stop Opts - Adjust the way a container is stopped.
- Container
Stop Opts Builder - A builder struct for ContainerStopOpts.
- Container
TopOpts - Adjust how container stats are reported.
- Container
TopOpts Builder - A builder struct for ContainerTopOpts.
- Container
Wait Opts - Adjust how to wait for a container.
- Container
Wait Opts Builder - A builder struct for ContainerWaitOpts.
- Events
Opts - Used to filter events returned by Podman::events.
- Events
Opts Builder - A builder struct for EventsOpts.
- Exec
Create Opts - Modify how an exec session is run inside a container.
- Exec
Create Opts Builder - A builder struct for ExecCreateOpts.
- Exec
Start Opts - Adjust how an exec instance is started inside of a running container.
- Exec
Start Opts Builder - A builder struct for ExecStartOpts.
- Image
Build Opts - Adjust how an image is built.
- Image
Build Opts Builder - A builder struct for ImageBuildOpts.
- Image
Export Opts - Adjust how an image is exported.
- Image
Export Opts Builder - A builder struct for ImageExportOpts.
- Image
Import Opts - Adjust how an image is imported.
- Image
Import Opts Builder - A builder struct for ImageImportOpts.
- Image
List Opts - Adjust how images are listed.
- Image
List Opts Builder - A builder struct for ImageListOpts.
- Image
Prune Opts - Adjust how unused images are removed.
- Image
Prune Opts Builder - A builder struct for ImagePruneOpts.
- Image
Push Opts - Adjust how an image is pushed to a registry.
- Image
Push Opts Builder - Image
Search Opts - Adjust how to search for images in registries.
- Image
Search Opts Builder - A builder struct for ImageSearchOpts.
- Image
TagOpts - Adjust the way an image is tagged/untagged.
- Image
TagOpts Builder - A builder struct for ImageTagOpts.
- Image
Tree Opts - Adjust how the image tree is retrieved.
- Image
Tree Opts Builder - A builder struct for ImageTreeOpts.
- Images
Export Opts - Adjust how multiple images are exported.
- Images
Export Opts Builder - A builder struct for ImagesExportOpts.
- Images
Remove Opts - Adjust how multiple images will be removed.
- Images
Remove Opts Builder - A builder struct for ImagesRemoveOpts.
- Manifest
Create Opts - Adjust how a manifest list is created.
- Manifest
Create Opts Builder - A builder struct for ManifestCreateOpts.
- Manifest
Image AddOpts - Adjust how an image is added to a manifest list.
- Manifest
Image AddOpts Builder - A builder struct for ManifestImageAddOpts.
- Manifest
Push Opts - Adjust how a manifest list is pushed to a registry.
- Manifest
Push Opts Builder - A builder struct for ManifestPushOpts.
- Network
Connect Opts - Adjust how a container is connected to a network.
- Network
Connect Opts Builder - A builder struct for NetworkConnectOpts.
- Network
Create Opts - Adjust how a network is created.
- Network
Create Opts Builder - A builder struct for NetworkCreateOpts.
- Network
Disconnect Opts - Adjust how a container is disconnected from a network.
- Network
Disconnect Opts Builder - A builder struct for NetworkDisconnectOpts.
- Network
List Opts - Adjust how networks are listed.
- Network
List Opts Builder - A builder struct for NetworkListOpts.
- Network
Prune Opts - Adjust how unused networks are removed.
- Network
Prune Opts Builder - A builder struct for NetworkPruneOpts.
- Platform
- Used to set the image platform with
platform. - Play
Kubernetes Yaml Opts - Adjust how a kubernetes YAML will create pods and containers.
- Play
Kubernetes Yaml Opts Builder - A builder struct for PlayKubernetesYamlOpts.
- PodCreate
Opts - Adjust the way a pod is created.
- PodCreate
Opts Builder - A builder struct for PodCreateOpts.
- PodList
Opts - Adjust the list of returned pods with this options.
- PodList
Opts Builder - A builder struct for PodListOpts.
- PodStats
Opts - Adjust how stats of a process are listed.
- PodStats
Opts Builder - A builder struct for PodStatsOpts.
- PodTop
Opts - Adjust how processes inside a pod are listed.
- PodTop
Opts Builder - A builder struct for PodTopOpts.
- Pull
Opts - Pull
Opts Builder - Registry
Auth Builder - Secret
Create Opts - Used to create a Secret.
- Secret
Create Opts Builder - A builder struct for SecretCreateOpts.
- Systemd
Units Opts - Adjust how systemd units are generated from a container or pod.
- Systemd
Units Opts Builder - A builder struct for SystemdUnitsOpts.
- Volume
Create Opts - Adjust how a volume is created
- Volume
Create Opts Builder - A builder struct for VolumeCreateOpts.
- Volume
List Opts - Adjust the list of returned volumes with this options.
- Volume
List Opts Builder - A builder struct for VolumeListOpts.
- Volume
Prune Opts - Adjust how volumes will be pruned.
- Volume
Prune Opts Builder - A builder struct for VolumePruneOpts.
Enums§
- Container
List Filter - Used to filter listed containers by one of the variants.
- Container
Prune Filter - Used to filter removed images.
- Container
Restart Policy - Used with
ContainerCreateOptsBuilder::restart_policy. - Diff
Type - Used with
ChangesOptsBuilder::diff_type. - Image
List Filter - Used to filter listed images by one of the variants.
- Image
Opt - Used to filter listed images with
ImagesListFilter. - Image
Prune Filter - Used to filter removed images.
- Image
Search Filter - Used to filter searched images.
- Image
Volume Mode - Mode used to configure image volume with
image_volume_mode. - Network
List Filter - Used to filter listed network configurations by one of the variants.
- Network
Mode - The networking mode for the run commands during image build.
- Network
Prune Filter - Used to filter unused networks to remove.
- PodList
Filter - Used to filter listed pods by one of the variants.
- Pull
Policy - The networking mode for the run commands during image build.
- Registry
Auth - Seccomp
Policy - Used with
ContainerCreateOptsBuilder::seccomp_policy. - Socket
Notify Mode - How to handle the
NOTIFY_SOCKET. Used withsdnotify_mode. - Systemd
Enabled - Used with
ContainerCreateOptsBuilder::systemd. - Systemd
Restart Policy - Used with
SystemdUnitsOptsBuilder::restart_policy. - UserOpt
- One of the variants accepted by
ExecCreateOptsBuilder::user. - Volume
List Filter - Used to filter listed volumes by one of the variants.
- Volume
Prune Filter - Used to filter pruned volumes.