proxmox/docs/01-getting-started/LIST_VMS_QUICK_START.md

# Quick Start: List All Proxmox VMs

**Last Updated:** 2026-01-31  
**Document Version:** 1.0  
**Status:** Active Documentation

---

## Quick Start (Python Script)

```bash
# 1. Install dependencies (if not already installed)
cd /home/intlc/projects/proxmox
source venv/bin/activate
pip install proxmoxer requests

# 2. Ensure ~/.env has Proxmox credentials
# (Should already be configured)

# 3. Run the script
python3 list_vms.py
```

## Quick Start (Shell Script)

```bash
# 1. Set Proxmox host (or use default)
export PROXMOX_HOST=192.168.11.10
export PROXMOX_USER=root

# 2. Run the script
./list_vms.sh
```

## Expected Output

```
VMID   | Name                    | Type | IP Address         | FQDN                    | Description
-------|-------------------------|------|-------------------|-------------------------|----------------
100    | vm-example              | QEMU | 192.168.1.100     | vm-example.local         | Example VM
101    | container-example       | LXC  | 192.168.1.101     | container.local         | Example container
```

## Troubleshooting

**Connection timeout?**
- Check: `ping $(grep PROXMOX_HOST ~/.env | cut -d= -f2)`
- Verify firewall allows port 8006

**Authentication failed?**
- Check credentials in `~/.env`
- Verify API token is valid

**No IP addresses?**
- QEMU: Install QEMU guest agent in VM
- LXC: Container must be running

## Files

- `list_vms.py` - Python script (recommended)
- `list_vms.sh` - Shell script (requires SSH)
- `LIST_VMS_README.md` - Full documentation