跳到主要内容

命令介绍

podman farm list 是 Podman 工具的一个命令，用于列出在 Podman Farm 中定义的所有容器。Podman Farm 是 Podman 容器管理的一个高级特性，它允许用户以集合的方式管理和操作多个容器。

命令概述​

podman farm list 命令用于显示当前系统中定义的所有 Farm 的列表。每个 Farm 可以包含多个容器，并且可以通过 Farm 进行统一的管理和配置。

命令语法​

podman farm list [OPTIONS]

命令选项​

podman farm list 命令支持多种选项，用于定制命令的输出和行为：

  • -a, --all：显示所有 Farm，包括那些当前未运行的 Farm。默认情况下，可能只显示正在运行的 Farm。
  • --format：使用 Go 模板语言来自定义输出格式。你可以指定如何显示 Farm 的不同属性，例如名称、状态、ID 等。
  • -h, --help：显示关于 podman farm list 命令的帮助信息。
  • --quiet, -q：仅显示 Farm 的 ID 或名称，而不显示其他详细信息。这可以使输出更加简洁。
  • --sort：根据一个或多个字段对输出进行排序。例如，你可以根据 Farm 的名称或创建时间进行排序。

输出内容​

podman farm list 命令的输出通常包含以下信息：

  • Farm ID：每个 Farm 的唯一标识符。
  • Farm Name：Farm 的名称，用于标识和引用特定的 Farm。
  • Status：Farm 的当前状态，例如运行中、停止等。
  • Containers：Farm 中包含的容器列表或数量。
  • 其他属性：根据所使用的 --format 选项，输出可能还包含 Farm 的其他属性，如创建时间、更新时间等。

示例​

列出所有 Farm​

要列出当前定义的所有 Farm，可以运行以下命令：

podman farm list
名称        连接          默认    读写
farm1       [f38 f37]    false       true
farm2       [f37]        true        true

输出内容详解​

  • 名称：Farm 的名称，用于唯一标识每个 Farm。在这个例子中，有两个 Farm，分别是 farm1 和 farm2。
  • 连接：显示 Farm 当前连接的容器列表。在这个例子中，farm1 连接了 [f38 f37] 两个容器，而 farm2 只连接了 [f37] 一个容器。这里的 f38 和 f37 可能是容器的标识符，具体取决于你的 Podman 配置和 Farm 的定义。
  • 默认：表示该 Farm 是否被设置为默认 Farm。默认 Farm 通常会在没有指定具体 Farm 的情况下，作为操作的默认目标。在这个例子中，farm2 是默认 Farm（true），而 farm1 不是（false）。
  • 读写：表示该 Farm 是否支持读写操作。这通常与 Farm 的配置和状态有关。在这个例子中，两个 Farm 都支持读写操作（true）。

输出解读​

从输出中，我们可以得出以下结论：

  • farm1 连接了两个容器 f38 和 f37，但它不是默认 Farm，并且支持读写操作。
  • farm2 只连接了一个容器 f37，它是默认 Farm，并且也支持读写操作。

注意，连接状态可能表示 Farm 与容器之间的实际连接情况，也可能只是表示 Farm 配置中指定的容器列表。实际运行中，这些容器可能正在运行，也可能处于停止状态。

使用场景​

podman farm list 命令在以下场景中非常有用：

  • 查看 Farm 配置：当你想要了解当前系统中定义了哪些 Farm，以及每个 Farm 的连接状态和配置时。
  • 诊断问题：如果某个 Farm 的容器没有按预期运行，你可以通过查看 Farm 的连接状态来诊断问题。
  • 管理 Farm：在需要对 Farm 进行进一步管理操作（如启动、停止容器，或更改 Farm 配置）之前，先通过 podman farm list 命令了解当前状态。

以自定义格式列出 Farm​

你可以使用 --format 选项来定制输出格式。例如，下面的命令将只显示 Farm 的名称和状态：

podman farm list --format "{{.Name}}\t{{.Status}}"

这里 {{.Name}} 和 {{.Status}} 是 Go 模板语法中的占位符，分别表示 Farm 的名称和状态。\t 是制表符，用于在输出中分隔字段。

列出所有 Farm 的 ID​

如果你只关心 Farm 的 ID，可以使用 --quiet 选项：

podman farm list --quiet

这将只输出每个 Farm 的 ID，每行一个。

注意事项​

  • 请确保你的 Podman 版本支持 Farm 功能。Farm 是 Podman 的一个较新特性，可能不是所有版本都包含。
  • 在执行 podman farm list 命令之前，你可能需要具有足够的权限来访问和列出 Farm。这通常意味着你需要以 root 用户或具有适当权限的用户身份运行命令。
  • podman farm list 命令的输出可能会受到其他 Podman 配置和设置的影响，例如 Farm 的定义和状态。

通过 podman farm list 命令，你可以轻松地查看系统中定义的 Farm 列表，并根据需要进行进一步的管理和配置。这有助于你更好地组织和控制一组相关的容器。

选项​

--format=format​

更改默认的输出格式。这可以是支持的类型，如 'json'，或者一个Go模板。 Go模板中有效的占位符如下：

占位符描述
.Connectionsfarm中的所有系统连接列表
.Default指示farm是否为默认farm
.Namefarm名称
.ReadWrite指示是否可以使用 podman farm 命令修改此farm

另请参阅​

podman(1), podman-farm(1)

历史​

2023年7月，由Urvashi Mohnani最初编译。