cv4pve api php

cv4pve-api-php

Proxmox VE Client API PHP

Proxmox VE API

   ______                _                      __
  / ____/___  __________(_)___ _   _____  _____/ /_
 / /   / __ / ___/ ___/ / __  | / / _ / ___/ __/
/ /___/ /_/ / /  (__  ) / / / / |/ /  __(__  ) /_
____/____/_/  /____/_/_/ /_/|___/___/____/__/

Corsinvest for Proxmox VE Api Client  (Made in Italy)

Urheberrecht und Lizenz

Urheberrecht: Corsinvest Srl. Einzelheiten zur Lizenzierung finden Sie unter LIZENZ

Kommerzieller Support

Diese Software ist Teil einer Suite von Tools namens cv4pve-tools. Wenn Sie kommerzielle Unterstützung wünschen, besuchen Sie die Website

Allgemein

Der Client wird aus einer JSON-API auf Proxmox VE generiert.

Mit dieser PHP 5.4+-Bibliothek können Sie über eine API mit Ihrem Proxmox-Server interagieren. Der Client wird aus einer JSON-API auf Proxmox VE generiert.

Ergebnis

Das Ergebnis ist die Klasse Result und enthält Methoden:

• getResponse() zurückgegeben von Proxmox VE (Daten, Fehler,...) Objekt/Array
• ResponseInError (bool): Enthält Fehler von Proxmox VE.
• getStatusCode() (int) : Statuscode der HTTP-Antwort.
• getReasonPhrase() (Zeichenfolge): Die Begründungsphrase, die normalerweise von Servern zusammen mit dem Statuscode gesendet wird.
• isSuccessStatusCode() (bool): Ruft einen Wert ab, der angibt, ob die HTTP-Antwort erfolgreich war.
• getError() (string): Fehler abrufen.
• getResponseHeaders() (string) : Ruft die rohen HTTP-Header ab, die dieser Antwort zugeordnet sind.

Hauptmerkmale

• Leicht zu erlernen
• Keine Abhängigkeit von der externen Bibliothek, nur natives Curl
• Die Implementierung berücksichtigt die API-Struktur von Proxmox VE
• Methode benannt
• Legen Sie den ResponseType json, png fest
• Vollständige Methode, generiert aus der Dokumentation
• Kommentieren Sie alle Methoden und Parameter
• Indizierte Parameter, z. B. [n], sind in Array-Index und -Wert strukturiert
• Baumstruktur
  • $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data
• Rückgabedaten proxmox
• Ergebnis zurückgeben
  • Anfrage
  • Antwort
  • Status
• Warten Sie, bis die Aufgabe abgeschlossen ist
  • waitForTaskToFinish
  • taskIsRunning
  • getExitStatusTask
• Methode Direktzugriff
  • erhalten
  • Satz
  • erstellen
  • löschen
• Login gibt bool zurück, wenn Zugriff
• Weitere Informationen zur Return Result-Klasse
• Gibt Objekt-/Array-Daten zurück
  • Standardobjektdeaktivierung von client.setResultIsObject(false)
• ClientBase Lite-Funktion
• Formular Proxmox VE 6.2 unterstützt API-Token für Benutzer
• Melden Sie sich mit einem Einmalpasswort für die Zwei-Faktor-Authentifizierung an.
• Legen Sie eine Zeitüberschreitung für die Verbindung fest.

API-Token

Ab Version 6.2 von Proxmox VE ist die Verwendung von Api-Token möglich. Diese Funktion ermöglicht die Ausführung der API ohne Verwendung von Benutzer und Passwort. Wenn Sie beim Erstellen eines API-Tokens die Privilegientrennung verwenden, denken Sie daran, die Berechtigung anzugeben. Format USER@REALM!TOKENID=TOKEN (Verwendungsbeispiel unten)

Installation

Die empfohlene Installation ist die Verwendung von [Composer]. Wenn Sie [Composer] nicht haben, worauf warten Sie noch?

Führen Sie im Stammverzeichnis Ihres Projekts Folgendes aus:

composer require Corsinvest/cv4pve-api-php

Oder fügen Sie dies zu Ihrer composer.json hinzu

Verwendung

 <?php

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

//if you want use lite version only get/set/create/delete use PveClientBase

$ client = new Corsinvest  ProxmoxVE  Api  PveClient ( " 192.168.0.24 " );

//login check bool
if ( $ client -> 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 " <img src=' { $ client -> getNodes ()-> get ( " pve1 " )-> getRrd ()-> rrd ( ' cpu ' , ' day ' )-> 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 ();
}

Beispielanforderung für eine Ausgabeversion:

 //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 "
  }
}

Der in der Dokumentation mit „[n]“ indizierte Parameter (Methode createVM in der Qemu-Parameteridee) erfordert ein Array mit Schlüssel und Wert

[
  1 => " .... " ,
  3 => " .... " ,
]

Nutzung mit API-Token statt Benutzername/Passwort

 <?php

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

//if you want use lite version only get/set/create/delete use PveClientBase

$ client = new Corsinvest  ProxmoxVE  Api  PveClient ( " hostname " , " 8006 " );
$ client -> setApiToken ( " root@pam!mytokenname=<TOKEN COMES HERE> " );
echo $ client -> getVersion ();