Skip to content
This repository has been archived by the owner on Sep 16, 2022. It is now read-only.
/ proxmox Public archive
forked from MrKampf/proxmoxVE

The is a PHP 7.4/8 ProxmoxVe API client. With it you can easily and quickly retrieve information from your Proxmox server or cluster.

License

Notifications You must be signed in to change notification settings

Performave/proxmox

 
 

Repository files navigation

Deprecated

This library has been deprecated in favor of custom written logic to call Proxmox API. This is because the library was poorly designed and became hard to maintain.

Proxmox API

This PHP 8+ Proxmox library allows you to interact with your Proxmox PVE server and cluster in an object-oriented way.

This library is a fork of another library, and this library is actively maintained as it's being used in a real project.

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require

If you find any errors, typos, or errors issue. I'll try to release a hotfix

Getting Started

Install using Composer via the command-line

$ composer require performave/proxmox

Example


From version 3.1

<?php
// Require the autoloader
require_once 'vendor/autoload.php';

// Use the library namespace
use Proxmox\PVE;

// Then simply pass your credentials when creating the API client object.
$proxmox = new PVE("hostname", "username", "password", 8006, "pve", false);

//Read all nodes
print_r($proxmox->nodes()->get());

//Read all lxc
print_r($proxmox->nodes()->lxc()->get());

//Read all qemu
print_r($proxmox->nodes()->qemu()->get());

For version 3.1

WARNING: The array options is after version 3.0 no longer supported!
<?php
// Require the autoloader
require_once 'vendor/autoload.php';

// Use the library namespace
use Proxmox\PVE;

/**
 * Connect established (For version 3.0) 
 * 
 * authType and port defaults to 'pam' and '8006' but you can specify them like so
 * 
 * !!! WARNING !!!
 * This variant is after version 3.0 no longer supported
 * 
*/
$credentials = [
    'hostname' => '127.0.0.1',
    'username' => 'root',
    'password' => 'example',
    'authType' => 'pam',
    'port' => '8006',
];

// Then simply pass your credentials when creating the API client object.
$proxmox = new PVE($credentials);

//Read all nodes
print_r($proxmox->nodes()->get());

//Read all lxc
print_r($proxmox->nodes()->lxc()->get());

//Read all qemu
print_r($proxmox->nodes()->qemu()->get());

About

The is a PHP 7.4/8 ProxmoxVe API client. With it you can easily and quickly retrieve information from your Proxmox server or cluster.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%