Skip to content

Latest commit

 

History

History
246 lines (177 loc) · 5.8 KB

README.md

File metadata and controls

246 lines (177 loc) · 5.8 KB
Raw

Proxmox VM/LXC Manager

This script helps to start/stop/shutdown vms/lxc containers on multiple nodes without accessing the nodes.

This script was created with the help of ChatGPT, and even this README.md was written by ChatGPT. I'm not a Python expert, but the script should be helpful for anyone who wants a quick way to manage VMs or containers on a Proxmox environment.

Features

  • Start, stop, or shut down Proxmox VMs and containers by ID.
  • Fetch the status of VMs/containers.
  • Supports both synchronous and asynchronous execution.

Requirements

  • A Proxmox environment with pvesh command-line tool.
  • Python 3.x installed.

Installation

  1. Download the script to your Proxmox machine:

    curl -O https://raw.githubusercontent.com/aizatto/pmx/main/pmx.py
cd proxmox-manager

  2. Make the script executable:

    chmod +x pmx.py

Usage

The script takes a followed by one or more VM/Container IDs.

Example:

./pmx.py status 100

Available commands:

  1. status
  2. start
  3. shutdown
  4. stop
  5. reboot
  6. suspend
  7. destroy
  8. snapshot
  9. delsnapshot
  10. listsnapshot
  11. replications
  12. replication-schedule-now
  13. vzdump
  14. ha
  15. ha-set
  16. ha-set-started-all
  17. ha-set-ignored-all

Get the status of all your containers

./pmy.py

Get the status of one or more VMs/containers

./pmx.py status 101 102
lxc/101 running 1h 23m
qemu/102 stopped

Start a VM or container

./pmx.py start 101 102 103
Starting VM 101...
Starting VM 102...
VM 103 is already running. Only 'stop' or 'shutdown' are allowed.

Stop a VM or container

./pmx.py stop 101 102
Stopping VM 101...
VM 102 is already stopped. Only 'start' is allowed.

Shutdown a VM or container

./pmx.py shutdown 101

Destroy a VM or container

./pmx.py destroy 101

You will be asked to confirm if you want to destroy vm. You can skip confirmation by passing --skip-confirm.

By default, jobs will be purged, and unreferenced disks destroyed. You can use the arguments:

  1. --do-not-purge-jobs to not purge from job configurations
  2. --do-not-destroy-unreferenced-disks to not destroy unreferenced disks

Snapshot a VM or container

./pmx.py snapshot --name snapshot-test --description "testing snapshots" 101

Arguments:

  1. --name Required. snapshot name
  2. --description Optional

Delete Snapshot of a VM or container

./pmx.py delsnapshot --name snapshot-test 101

Arguments:

  1. --name Required. snapshot name

List Snapshots of VM or container

./pmx.py delsnapshot --name snapshot-test 101

Arguments:

  1. --name Required. snapshot name

List Replications

./pmx.py replications
./pmx.py replications 101 102
./pmx.py --node replications node1

Replicate a VM or container

./pmx.py replication-schedule-now 101

Get HA (High Availability) status

./pmx.py ha
./pmx.py ha 100 101
./pmx.py --node ha node1

Set HA state

State can be one of:

  1. started: The CRM tries to start the resource. Service state is set to started after successful start. On node failures, or when start fails, it tries to recover the resource. If everything fails, service state it set to error.
  2. stopped: The CRM tries to keep the resource in stopped state, but it still tries to relocate the resources on node failures.
  3. disabled: The CRM tries to put the resource in stopped state, but does not try to relocate the resources on node failures. The main purpose of this state is error recovery, because it is the only way to move a resource out of the error state.
  4. ignored: The resource gets removed from the manager status and so the CRM and the LRM do not touch the resource anymore. All {pve} API calls affecting this resource will be executed, directly bypassing the HA stack. CRM commands will be thrown away while there source is in this state. The resource will not get relocated on node failures.
./pmx.py --ha-state started ha-set 100 101
./pmx.py --ha-state ignored ha-set node1

Remove HA

./pmx.py ha-delete 100

Start all, or ignore all AH

Useful when turning off all your proxmox nodes.

./pmx.py ha-set-started-all
./pmx.py ha-set-ignored-all
./pmx.py ha-delete 100

Global Arguments

Run synchronously --sync

By default, commands are executed asynchronously. To run them synchronously, pass the --sync argument:

./pmx.py --sync start 101

Targetting a Node --node

You can pass a --node argument if you want the selector to select pods based on a node.

For example, assuming the environment looks like:

  1. node1
    1. lxc/100
    2. lxc/101
  2. node2
    1. lxc/103

You can return the status of all vms on the Node via

./pmx.py --node status node1

This works with start, shutdown, stop, and destroy.

Notes:

  • If a VM/container is stopped, only the start command will be allowed.
  • If a VM/container is running, only the stop or shutdown commands will be allowed.
  • The script retrieves the node and type (qemu or lxc) automatically from the Proxmox cluster.

Handling Keyboard Interrupts

The script supports graceful handling of Ctrl+C, so you can stop execution safely.

Contributions

Feel free to contribute! Fork the repository and submit a pull request if you'd like to improve or fix anything.

License

This project is licensed under the MIT License.

Docs

  1. Proxmox API Viewer
  2. pvesh
  3. pct
  4. qm