cv4pve api php

cv4pve-api-php

API client Proxmox VE PHP

API Proxmox VE

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

Corsinvest for Proxmox VE Api Client  (Made in Italy)

Droit d'auteur et licence

Copyright : Corsinvest Srl Pour plus de détails sur la licence, veuillez visiter LICENCE

Assistance commerciale

Ce logiciel fait partie d'une suite d'outils appelée cv4pve-tools. Si vous souhaitez un support commercial, visitez le site

Général

Le client est généré à partir d'une API JSON sur Proxmox VE.

Cette bibliothèque PHP 5.4+ vous permet d'interagir avec votre serveur Proxmox via API. Le client est généré à partir d'une API JSON sur Proxmox VE.

Résultat

Le résultat est la classe Result et contient les méthodes :

• getResponse() renvoyé par Proxmox VE (données, erreurs,...) Objet/Tableau
• réponseInError (bool) : contient les erreurs de Proxmox VE.
• getStatusCode() (int) : Code d'état de la réponse HTTP.
• getReasonPhrase() (string) : la phrase de raison qui est généralement envoyée par les serveurs avec le code d'état.
• isSuccessStatusCode() (bool) : obtient une valeur qui indique si la réponse HTTP a réussi.
• getError() (string) : Récupère l'erreur.
• getResponseHeaders() (string) : récupère les en-têtes HTTP bruts associés à cette réponse.

Principales caractéristiques

• Facile à apprendre
• Aucune bibliothèque externe de dépendance uniquement curl natif
• La mise en œuvre respecte la structure Api de Proxmox VE
• Méthode nommée
• Définir ResponseType json, png
• Méthode complète générée à partir de la documentation
• Commentez toute méthode et tous les paramètres
• Les paramètres indexés, par exemple [n], sont structurés en index et valeur de tableau
• Arborescence
  • $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data
• Renvoyer les données à proximité
• Retourner le résultat
  • Demande
  • Réponse
  • Statut
• Attendre la tâche terminer la tâche
  • attendre la tâche pour finir
  • la tâche est en cours d'exécution
  • getExitStatusTask
• Méthode d'accès direct
  • obtenir
  • ensemble
  • créer
  • supprimer
• La connexion renvoie un booléen en cas d'accès
• Retourner la classe de résultats plus d'informations
• Renvoie les données d'un objet/tableau
  • objet par défaut désactivé depuis client.setResultIsObject (false)
• Fonction ClientBase légère
• Form Proxmox VE 6.2 prend en charge le jeton Api pour l'utilisateur
• Connectez-vous avec un mot de passe à usage unique pour une authentification à deux facteurs.
• Définissez le délai d'expiration pour la connexion.

Jeton API

À partir de la version 6.2 de Proxmox VE, il est possible d'utiliser le jeton Api. Cette fonctionnalité permet d'exécuter l'API sans utiliser d'utilisateur ni de mot de passe. Si vous utilisez la séparation des privilèges lors de la création d'un jeton API, n'oubliez pas de spécifier l'autorisation. Format USER@REALM!TOKENID=TOKEN (Exemple d'utilisation ci-dessous)

Installation

L'installation recommandée utilise [Composer], si vous n'avez pas [Composer], qu'attendez-vous ?

À la racine de votre projet, exécutez ce qui suit :

composer require Corsinvest/cv4pve-api-php

Ou ajoutez ceci à votre composer.json

Usage

 <?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 ();
}

Exemple de demande de version de sortie :

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

Le paramètre indexé se termine par '[n]' dans la documentation (méthode createVM dans le paramètre Qemu ide) nécessite un tableau avec la clé et la valeur

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

Utilisation avec un jeton API à la place du nom d'utilisateur/mot de passe

 <?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 ();