Skip to main content

pve-cli

CLI Tool to manage VMs and more on proxmox clusters

Features

Prevent migration

Migration of a VM by pve-cli can be prevented if the tag do-not-migrate is added to the VM. The migration of VMs with this tags can be forced with --force. This is implemented for the commands pve-cli vm VM migrate, pve-cli cluster reboot and pve-cli cluster vm-mapping restore.

Config

For config option reference see config.example.toml. The config file path can be provided via command line option --config/-c and is searched by default in the following paths:

  • Linux (Unix): ~/.config/pve-cli/config.toml
  • MacOS: ~/Library/Application Support/pve-cli/config.toml
  • Windows: C:\Users\<user>\AppData\Local\pve-cli\config.toml

This leverages the get_app_dir method from click.

Required PVE Permissions

For full functionallity following permissions are required:

  • Sys.Audit
  • Sys.PowerMgmt
  • VM.Audit
  • VM.GuestAgent.Unrestricted
  • VM.Migrate
  • VM.PowerMgmt

With the following line in /etc/pve/user.cfg you can create a role CLI-Tool:

role:CLI-Tool:Sys.Audit,Sys.PowerMgmt,VM.Audit,VM.GuestAgent.Unrestricted,VM.Migrate,VM.PowerMgmt:

Until PVE 9 instead of VM.GuestAgent.Unrestricted the permission VM.Monitor was needed.

Metadata

Release files for pve-cli 0.10.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pve-cli 0.10.2
File Size Uploaded Provenance
pve_cli-0.10.2.tar.gz 13.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pve-cli 0.10.2
File Interpreter ABI Platform
pve_cli-0.10.2-py3-none-any.whl Python 3 none any Details

Total release size: 34.2 kB

Release files / pve_cli-0.10.2.tar.gz

Download URL pve_cli-0.10.2.tar.gz
Size 13.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0d5afaea31e53ce3d2fb364c1f89c9e2b0618785d3424d99f68b6115391c5b7a
BLAKE2b-256 checksum
How to use checksums
f30dad3b4bbc680646db7fcccb5c3e4837091c1bed1588c247ac899db00908de
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.24 {"installer":{"name":"uv","version":"0.9.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pve_cli-0.10.2-py3-none-any.whl

Download URL pve_cli-0.10.2-py3-none-any.whl
Size 20.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
46eb2420bdf2caa22b78a095d0eed8b052fe9334a677dc5597d525d68ca7fe2a
BLAKE2b-256 checksum
How to use checksums
62c7caa2c8f81303104e78928f923c78a47c37f27f48789701ee81fd55d354f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.24 {"installer":{"name":"uv","version":"0.9.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for pve-cli 0.10.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.10.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page