Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Corsinvest/cv4pve-api-php

Proxmox VE Client API for PHP
https://github.com/Corsinvest/cv4pve-api-php

api api-client api-gateway api-rest cluster enterprise eve2pve-api-php lxc php php-library proxmox proxmox-apis proxmox-cluster proxmox-ve proxmoxve pve qemu

Last synced: about 2 months ago
JSON representation

Proxmox VE Client API for PHP

Host: GitHub
URL: https://github.com/Corsinvest/cv4pve-api-php
Owner: Corsinvest
License: gpl-3.0
Created: 2017-09-11T10:12:48.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-04-02T08:42:33.000Z (9 months ago)
Last Synced: 2024-04-02T09:57:29.603Z (9 months ago)
Topics: api, api-client, api-gateway, api-rest, cluster, enterprise, eve2pve-api-php, lxc, php, php-library, proxmox, proxmox-apis, proxmox-cluster, proxmox-ve, proxmoxve, pve, qemu
Language: PHP
Homepage: https://www.corsinvest.it/cv4pve
Size: 497 KB
Stars: 58
Watchers: 5
Forks: 23
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-proxmox-ve - cv4pve-api-php

README

        # cv4pve-api-php

[![License](https://img.shields.io/github/license/Corsinvest/cv4pve-api-php.svg)](LICENSE) [![Packagist Version](https://img.shields.io/packagist/v/corsinvest/cv4pve-api-php.svg)](https://packagist.org/packages/Corsinvest/cv4pve-api-php) ![Packagist Downloads (custom server)](https://img.shields.io/packagist/dt/corsinvest/cv4pve-api-php)

Proxmox VE Client API PHP

[Proxmox VE Api](https://pve.proxmox.com/pve-docs/api-viewer/)

```text

   ______                _                      __

  / ____/___  __________(_)___ _   _____  _____/ /_

 / /   / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/

/ /___/ /_/ / /  (__  ) / / / / |/ /  __(__  ) /_

\____/\____/_/  /____/_/_/ /_/|___/\___/____/\__/

Corsinvest for Proxmox VE Api Client  (Made in Italy)

```

## Copyright and License

Copyright: Corsinvest Srl

For licensing details please visit [LICENSE](LICENSE)

## Commercial Support

This software is part of a suite of tools called cv4pve-tools. If you want commercial support, visit the [site](https://www.corsinvest.it/cv4pve)

## General

The client is generated from a JSON Api on Proxmox VE.

This PHP 5.4+ library allows you to interact with your Proxmox server via API.

The client is generated from a JSON Api on Proxmox VE.

## Result

The result is class **Result** and contain methods:

* **getResponse()** returned from Proxmox VE (data,errors,...) Object/Array

* **responseInError** (bool) : Contains errors from Proxmox VE.

* **getStatusCode()** (int) : Status code of the HTTP response.

* **getReasonPhrase()** (string): The reason phrase which typically is sent by servers together with the status code.

* **isSuccessStatusCode()** (bool) : Gets a value that indicates if the HTTP response was successful.

* **getError()** (string) : Get error.

* **getResponseHeaders()** (string) : Gets the raw HTTP headers associated with this response.

## Main features

* Easy to learn

* No dependency external library only native curl

* Implementation respect the [Api structure of Proxmox VE](https://pve.proxmox.com/pve-docs/api-viewer/)

* Method named

* Set ResponseType json, png

* Full method generated from documentation

* Comment any method and parameters

* Parameters indexed eg [n] is structured in array index and value

* Tree structure

  * $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data

* Return data proxmox

* Return result

  * Request

  * Response

  * Status

* Wait task finish task

  * waitForTaskToFinish

  * taskIsRunning

  * getExitStatusTask

* Method direct access

  * get

  * set

  * create

  * delete

* Login return bool if access

* Return Result class more information

* Return object/array data

  * default object disable from client.setResultIsObject(false)

* ClientBase lite function

* Form Proxmox VE 6.2 support Api Token for user

* Login with One-time password for Two-factor authentication.

* Set Timeout for the Connection.

## Api token

From version 6.2 of Proxmox VE is possible to use [Api token](https://pve.proxmox.com/pve-docs/pveum-plain.html).

This feature permit execute Api without using user and password.

If using **Privilege Separation** when create api token remember specify in permission.

Format `USER@REALM!TOKENID=TOKEN` (Usage example below)

## Installation

Recommended installation is using [Composer], if you do not have [Composer] what are you waiting?

In the root of your project execute the following:

```sh

composer require Corsinvest/cv4pve-api-php

```

Or add this to your `composer.json`

## Usage

```php

login('root','password','pam')){

  //get version from get method

  var_dump($client->get('/version')->getResponse());

  // $client->put

  // $client->post

  // $client->delete

  $retPippo=$client->get("/pippo");

  echo "\n" . $retPippo->getStatusCode();

  echo "\n" . $retPippo->getReasonPhrase();

  //loop nodes

  foreach ($client->getNodes()->Index()->getResponse()->data as $node) {

    echo "\n" . $node->id;

  }

  //loop vm

  foreach ($client->getNodes()->get("pve1")->getQemu()->Vmlist()->getResponse()->data as $vm) {

      echo "\n" . $vm->vmid ." - " .$vm->name;

  }

  //loop snapshots

  foreach ($client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data as $snap) {

    echo "\n" . $snap->name;

  }

  //return object

  var_dump($client->getVersion()->version()->getResponse());

  //disable return object

  $client->setResultIsObject(false);

  //return array

  $retArr = $client->getVersion()->version()->getResponse();

  var_dump($retArr);

  echo "\n" . $retArr['data']['release'];

  //enable return objet

  $client->setResultIsObject(true);

  //image rrd

  $client->setResponseType('png');

  echo "getResponse()}' \>";

  //result json result

  $client->setResponseType('json');

  var_dump($client->get('/version')->getResponse());

  //set connection timeout (by default no timeout)

  $client->setTimeout(2)->get('/version')->getResponse();

}

```

Sample output version request:

```php

//object result

var_dump($client->getVersion()->Version()->getResponse());

object(stdClass)#9 (1) {

  ["data"]=>

  object(stdClass)#32 (4) {

    ["version"]=>

    string(3) "5.0"

    ["release"]=>

    string(2) "31"

    ["keyboard"]=>

    string(2) "it"

    ["repoid"]=>

    string(8) "27769b1f"

  }

}

//disable return object

$client->setResultIsObject(false);

//array result

var_dump($client->getVersion()->Version());

array(1) {

  ["data"]=>

  array(4) {

    ["repoid"]=>

    string(8) "2560e073"

    ["release"]=>

    string(2) "32"

    ["version"]=>

    string(3) "5.0"

    ["keyboard"]=>

    string(2) "it"

  }

}

```

The parameter indexed end with '[n]' in documentation (method createVM in Qemu parameter ide) require array whit key and value

```php

[

  1 => "....",

  3 => "....",

]

```

### Usage with API-token instead username/password

```php

setApiToken("root@pam!mytokenname=");

echo $client->getVersion();

```