Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

Proxmon

Proxmox monitoring cli tool Proxmon

Features

  • Monitor Proxmox nodes and VMs from the command line.
  • Display resource usage such as CPU, memory, and storage.
  • Fetch and display VM statuses in real-time.
  • Lightweight and easy to use.

Installation

  1. Clone the repository:
    git clone https://github.com/Sr-vZ/Proxmon.git
  2. Navigate to the project directory:
    cd proxmon
  3. Install dependencies:
    pip install -r requirements.txt
    # or
    uv sync

Setup

1. Create a proxmox API Token

  • Login to proxmox and add an api user
  • Add an API token for the api user, write down the secret
  • Grant appropriate permissions to the user and the API token

2. Create .env file

Note, all SSH_ parameters are optional. If provided, they will allow looking up VMs IP addresses and the host's CPU temperature

PROXMOX_HOST = https://proxmox.myorg.com:8006
TOKEN_ID = api@pve!api-token
TOKEN_SECRET = abc12345-6789-defg-1234-1234567890ab
NODE = proxmox
SSH_HOST = proxmox.myorg.com
SSH_PORT = 22
SSH_USER = api
SSH_PASSWORD = ssh-password

Usage

Run the tool with:

python proxmon.py

or, when using uv:

uv run python proxmon.py

Demo

Here is a quick demo of Proxmon in action: https://github.com/Sr-vZ/Proxmon/blob/main/assets/Proxmon_Demo.mp4

https://github.com/Sr-vZ/Proxmon/raw/refs/heads/main/assets/Proxmon_Demo.mp4

Contributing

Contributions are welcome! Please fork the repository and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Proxmox monitoring cli tool

Topics

Resources

Stars

39 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /