Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

JerichoJack/Proxmox-Inventory

Repository files navigation

Proxmox Inventory Collection Toolkit

Overview

This toolkit provides an easy, automated way to collect detailed inventory and configuration data from multiple Proxmox nodes in your homelab or production environment. It is designed to be portable and standalone—just copy this folder, update the config, and run the scripts from Windows.

Features

  • Collects hardware, VM, LXC, storage, network, and health info from all listed Proxmox nodes
  • Generates a comprehensive Markdown report (proxmox-inventory.md) for documentation, audits, or troubleshooting
  • No external dependencies—just update the config and run
  • Easily customizable for any Proxmox environment

Included Files

  • From-Windows-Collect-Proxmox-Inventory.ps1: Main PowerShell script to run from Windows. Connects to each node, runs the inventory script, and builds the report.
  • proxmox-node-inventory.sh: Bash script to be deployed and run on each Proxmox node. Collects all node data.
  • proxmox-nodes.json: Configuration file listing all nodes, IPs, users, and passwords. Edit this to match your environment.
  • proxmox-inventory.md: Output file. The generated Markdown report with all collected data.
  • deploy-to-proxmox-node-for-inventory.sh: Helper script to copy the inventory script to your nodes (optional).

How to Use

  1. Edit proxmox-nodes.json
    • Replace example entries with your actual Proxmox node info (name, IP, user, password).
  2. Deploy the Bash Script
    • Use deploy-to-proxmox-node-for-inventory.sh or manually copy proxmox-node-inventory.sh to each node.
    • Ensure it is executable: chmod +x ./proxmox-node-inventory.sh
  3. Run the PowerShell Script
    • On your Windows machine, open PowerShell and run:
      .\From-Windows-Collect-Proxmox-Inventory.ps1
    • The script will SSH into each node, run the inventory script, and collect the results.
  4. View the Report
    • Open proxmox-inventory.md for a full Markdown summary of your infrastructure.

Why Is This Useful?

  • Documentation: Quickly document your homelab or production Proxmox setup.
  • Auditing: Track hardware, VM, LXC, and storage changes over time.
  • Troubleshooting: Spot issues with storage, network, or resource allocation.
  • Migration/Planning: Use the report to plan upgrades, migrations, or expansions.

Customization

  • Add/remove nodes in proxmox-nodes.json as needed.
  • Edit the Bash or PowerShell scripts to collect additional data or change formatting.
  • Share the folder with others—no external dependencies required.

Requirements

  • Windows machine with PowerShell
  • PowerShell must have access to plink.exe and pscp.exe (from PuTTY) for SSH and file transfer
  • SSH access to all Proxmox nodes (root recommended)
  • Proxmox nodes must have Bash and basic Linux utilities
  • SSH login must be allowed for the specified user on each node
  • The user running the PowerShell script should have permission to execute scripts
  • Network connectivity between your Windows machine and all Proxmox nodes

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published