github.com/containers/podman/v5@v5.1.0-rc1/docs/source/markdown/podman-pause.1.md.in (about)

     1  % podman-pause 1
     2  
     3  ## NAME
     4  podman\-pause - Pause one or more containers
     5  
     6  ## SYNOPSIS
     7  **podman pause** [*options*] [*container*...]
     8  
     9  **podman container pause** [*options*] [*container*...]
    10  
    11  ## DESCRIPTION
    12  Pauses all the processes in one or more containers.  You may use container IDs or names as input.
    13  
    14  ## OPTIONS
    15  
    16  #### **--all**, **-a**
    17  
    18  Pause all running containers.
    19  
    20  @@option cidfile.read
    21  
    22  #### **--filter**, **-f**=*filter*
    23  
    24  Filter what containers pause.
    25  Multiple filters can be given with multiple uses of the --filter flag.
    26  Filters with the same key work inclusive with the only exception being
    27  `label` which is exclusive. Filters with different keys always work exclusive.
    28  
    29  Valid filters are listed below:
    30  
    31  | **Filter** | **Description**                                                                  |
    32  |------------|----------------------------------------------------------------------------------|
    33  | id         | [ID] Container's ID (CID prefix match by default; accepts regex)                 |
    34  | name       | [Name] Container's name (accepts regex)                                          |
    35  | label      | [Key] or [Key=Value] Label assigned to a container                               |
    36  | exited     | [Int] Container's exit code                                                      |
    37  | status     | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' |
    38  | ancestor   | [ImageName] Image or descendant used to create container                         |
    39  | before     | [ID] or [Name] Containers created before this container                          |
    40  | since      | [ID] or [Name] Containers created since this container                           |
    41  | volume     | [VolumeName] or [MountpointDestination] Volume mounted in container              |
    42  | health     | [Status] healthy or unhealthy                                                    |
    43  | pod        | [Pod] name or full or partial ID of pod                                          |
    44  | network    | [Network] name or full ID of network                                             |
    45  | until      | [DateTime] container created before the given duration or time.                  |
    46  
    47  @@option latest
    48  
    49  ## EXAMPLE
    50  
    51  Pause specified container:
    52  ```
    53  podman pause mywebserver
    54  ```
    55  
    56  Pause container by partial container ID:
    57  ```
    58  podman pause 860a4b23
    59  ```
    60  
    61  Pause all **running** containers:
    62  ```
    63  podman pause --all
    64  ```
    65  
    66  Pause container using ID specified in given files:
    67  ```
    68  podman pause --cidfile /home/user/cidfile-1
    69  podman pause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2
    70  ```
    71  
    72  Pause the latest container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines):
    73  ```
    74  podman pause --latest
    75  ```
    76  
    77  ## SEE ALSO
    78  **[podman(1)](podman.1.md)**, **[podman-unpause(1)](podman-unpause.1.md)**
    79  
    80  ## HISTORY
    81  September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>