PVE4J Wiki

Welcome to the PVE4J documentation. This wiki provides comprehensive guides and references for using PVE4J to manage your Proxmox Virtual Environment.

Table of Contents

Getting Started

• Getting Started - Installation and basic setup
• Authentication - API tokens and password authentication
• Client Configuration - Configure the Proxmox client

Core Concepts

• Request API - Understanding the fluent request API
• Task Handling - Working with asynchronous tasks
• Error Handling - Exception handling and troubleshooting

Resource Management

• VM Management - Complete guide to QEMU VM operations
• Container Management - LXC container operations
• Snapshot Management - VM and container snapshot operations

Infrastructure

• Node Management - Working with individual nodes
• Cluster Operations - Cluster-wide operations and HA
• Storage Management - Storage pool management
• Pool Management - Resource pool operations

Security

• Access Control - Users, groups, roles, and permissions
• Firewall Management - VM firewall configuration and rules

Community

• Contributing - How to contribute to PVE4J

Quick Links

• GitHub Repository
• Issue Tracker
• Proxmox VE API Documentation

About This Library

PVE4J is an open-source Java library that provides a modern, fluent interface for the Proxmox VE API. Built with Java 21+ features like virtual threads and records, it covers the core Proxmox API surface including VM and container lifecycle, cluster management, access control, storage, firewall, snapshots, guest agent, and more.

License

PVE4J is licensed under the GNU General Public License v3.0.