pvesh(1)

NAME

pvesh - Proxmox VE API 的 Shell 接口

pvesh <COMMAND> [ARGS] [OPTIONS]

pvesh create <api_path> [OPTIONS] [FORMAT_OPTIONS]

对 <api_path> 调用 API POST。

pvesh delete <api_path> [OPTIONS] [FORMAT_OPTIONS]

对 <api_path> 调用 API DELETE。

pvesh get <api_path> [OPTIONS] [FORMAT_OPTIONS]

对 <api_path> 调用 API GET。

pvesh help [OPTIONS]

获取指定命令的帮助。

pvesh ls <api_path> [OPTIONS] [FORMAT_OPTIONS]

列出 <api_path> 下的子对象。

pvesh set <api_path> [OPTIONS] [FORMAT_OPTIONS]

对 <api_path> 调用 API PUT。

pvesh usage <api_path> [OPTIONS]

打印 <api_path> 的 API 用法信息。

常用命令示例

pvesh get /nodes
pvesh get /nodes/<node>/status
pvesh ls /nodes/<node>

Proxmox VE 管理工具（pvesh）允许直接调用 API 函数，而无需使用 REST/HTTPS 服务器。

只有 root 允许执行该操作。

可以使用 --output-format 参数指定输出格式。默认格式 text 使用 ASCII 字符为表格绘制边框，并会将部分值转换为便于阅读的文本，例如：

也可以使用 --quiet 选项完全抑制输出。

--human-readable <boolean> (default = 1): 调用输出渲染函数以生成人类可读的文本。
--noborder <boolean> (default = 0): 不绘制边框（用于 text 格式）。
--noheader <boolean> (default = 0): 不显示列标题（用于 text 格式）。
--output-format <json | json-pretty | text | yaml> (default = text): 输出格式。
--quiet <boolean>: 禁止打印结果。

获取集群中的节点列表

# pvesh get /nodes

获取数据中心可用选项列表

# pvesh usage cluster/options -v

将 HTML5 NoVNC 控制台设置为数据中心的默认控制台

# pvesh set cluster/options -console html5

常用命令示例

# pvesh get /version
# pvesh get /nodes
# pvesh usage cluster/options -v

本程序是自由软件：你可以依据自由软件基金会发布的 GNU Affero General Public License 条款重新分发和/或修改本程序；可使用该许可证第 3 版，或（由你选择）任何后续版本。

发布本程序是希望它能够有用，但不提供任何担保；甚至不包含对适销性或特定用途适用性的默示担保。更多详情请参见 GNU Affero General Public License。

你应当已经随本程序收到一份 GNU Affero General Public License 的副本。如果没有，请访问： https://www.gnu.org/licenses/

本程序是自由软件：你可以依据自由软件基金会发布的 GNU Affero General Public License 条款重新分发和/或修改本程序；可使用该许可证第 3 版，或（由你选择）任何后续版本。

发布本程序是希望它能够有用，但不提供任何担保；甚至不包含对适销性或特定用途适用性的默示担保。更多详情请参见 GNU Affero General Public License。

你应当已经随本程序收到一份 GNU Affero General Public License 的副本。如果没有，请访问： https://www.gnu.org/licenses/