Skip to main content

CLI Tool to manage VMs and more on proxmox clusters

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pve_cli-0.10.2.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pve_cli-0.10.2-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file pve_cli-0.10.2.tar.gz.

File metadata

  • Download URL: pve_cli-0.10.2.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for pve_cli-0.10.2.tar.gz
Algorithm Hash digest
SHA256 0d5afaea31e53ce3d2fb364c1f89c9e2b0618785d3424d99f68b6115391c5b7a
MD5 73b05c29b50c0fa3a4d225c71909b352
BLAKE2b-256 f30dad3b4bbc680646db7fcccb5c3e4837091c1bed1588c247ac899db00908de

See more details on using hashes here.

File details

Details for the file pve_cli-0.10.2-py3-none-any.whl.

File metadata

  • Download URL: pve_cli-0.10.2-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for pve_cli-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 46eb2420bdf2caa22b78a095d0eed8b052fe9334a677dc5597d525d68ca7fe2a
MD5 5912a1363dbcd5e28ab818bb22d93e51
BLAKE2b-256 62c7caa2c8f81303104e78928f923c78a47c37f27f48789701ee81fd55d354f5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page