lumaserv/proxmoxve

A simple PHP 5.5+ Proxmox API client.

ProxmoxVE API Client

This PHP 5.5+ library allows you to interact with your Proxmox server via API., _(*1)

, _(*2)

I'm not actively maintaining this library anymore (I've left PHP behind) but the API is pretty stable, if it doesn't suit your needs take a look at the forks or better yet create a PR to add the things you're missing, if you're interested I can transfer the project to you., _(*3)

Looking for a PHP 5.3 library version? Search through the releases one that fits your needs, I recommend using the 2.1.1 version., _(*4)

Installation

Recommended installation is using Composer, if you do not have Composer what are you waiting?, _(*5)

In the root of your project execute the following:, _(*6)

$ composer require lumaserv/proxmoxve ~4.0.4

Or add this to your composer.json file:, _(*7)

{
    "require": {
        "lumaserv/proxmoxve": "~4.0.4"
    }
}

Then perform the installation:, _(*8)

$ composer install --no-dev

Usage

<?php

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

// Use the library namespace
use ProxmoxVE\Proxmox;

// Create your credentials array
$credentials = [
    'hostname' => 'proxmox.server.com',  // Also can be an IP
    'username' => 'root',
    'password' => 'secret',
];

// realm and port defaults to 'pam' and '8006' but you can specify them like so
$credentials = [
    'hostname' => 'proxmox.server.com',
    'username' => 'root',
    'password' => 'secret',
    'realm' => 'pve',
    'port' => '9009',
];

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

$allNodes = $proxmox->get('/nodes');

print_r($allNodes);

Sample output:, _(*9)

Array
(
    [data] => Array
        (
            [0] => Array
                (
                    [disk] => 2539465464
                    [cpu] => 0.031314446882002
                    [maxdisk] => 30805066770
                    [maxmem] => 175168446464
                    [node] => mynode1
                    [maxcpu] => 24
                    [level] =>
                    [uptime] => 139376
                    [id] => node/mynode1
                    [type] => node
                    [mem] => 20601992182
                )

        )

)

Want to know more nifty tricks?

Checkout our wiki., _(*10)

License

This project is released under the MIT License. See the bundled LICENSE file for details., _(*11)

Want to contribute?

Thank you! Take a look at the CONTRIBUTING, you could easily set up a development environment to get you started in no time!, _(*12)

upstream/master, _(*13)