Files
podman/docs/source/markdown/podman-pause.1.md.in
Riccardo Paolo Bestetti 6ad4742ba8 docs: add 'initialized' state to status filters
Previously, the 'initialized' state was not documented as an available
filter for various Podman commands.

This commit documents 'initialized' as a valid state that can be used to
filter the start, stop, restart, rm, pause, unpause, and ps commands.

Fixes: #25017
Signed-off-by: Riccardo Paolo Bestetti <pbl@bestov.io>
2025-01-15 19:28:27 +01:00

82 lines
3.1 KiB
Markdown

% podman-pause 1
## NAME
podman\-pause - Pause one or more containers
## SYNOPSIS
**podman pause** [*options*] [*container*...]
**podman container pause** [*options*] [*container*...]
## DESCRIPTION
Pauses all the processes in one or more containers. You may use container IDs or names as input.
## OPTIONS
#### **--all**, **-a**
Pause all running containers.
@@option cidfile.read
#### **--filter**, **-f**=*filter*
Filter what containers pause.
Multiple filters can be given with multiple uses of the --filter flag.
Filters with the same key work inclusive with the only exception being
`label` which is exclusive. Filters with different keys always work exclusive.
Valid filters are listed below:
| **Filter** | **Description** |
|------------|-------------------------------------------------------------------------------------------------|
| id | [ID] Container's ID (CID prefix match by default; accepts regex) |
| name | [Name] Container's name (accepts regex) |
| label | [Key] or [Key=Value] Label assigned to a container |
| exited | [Int] Container's exit code |
| status | [Status] Container's status: 'created', 'initialized', 'exited', 'paused', 'running', 'unknown' |
| ancestor | [ImageName] Image or descendant used to create container |
| before | [ID] or [Name] Containers created before this container |
| since | [ID] or [Name] Containers created since this container |
| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
| health | [Status] healthy or unhealthy |
| pod | [Pod] name or full or partial ID of pod |
| network | [Network] name or full ID of network |
| until | [DateTime] Containers created before the given duration or time. |
@@option latest
## EXAMPLE
Pause specified container:
```
podman pause mywebserver
```
Pause container by partial container ID:
```
podman pause 860a4b23
```
Pause all **running** containers:
```
podman pause --all
```
Pause container using ID specified in given files:
```
podman pause --cidfile /home/user/cidfile-1
podman pause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2
```
Pause the latest container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines):
```
podman pause --latest
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-unpause(1)](podman-unpause.1.md)**
## HISTORY
September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>