cv4pve api php

cv4pve-api-php

API Klien Proxmox VE PHP

Proxmox VE Api

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

Corsinvest for Proxmox VE Api Client  (Made in Italy)

Hak Cipta dan Lisensi

Hak Cipta: Corsinvest Srl Untuk rincian lisensi silakan kunjungi LISENSI

Dukungan Komersial

Perangkat lunak ini adalah bagian dari seperangkat alat yang disebut cv4pve-tools. Jika Anda menginginkan dukungan komersial, kunjungi situsnya

Umum

Klien dihasilkan dari JSON Api di Proxmox VE.

Pustaka PHP 5.4+ ini memungkinkan Anda berinteraksi dengan server Proxmox Anda melalui API. Klien dihasilkan dari JSON Api di Proxmox VE.

Hasil

Hasilnya adalah Hasil kelas dan berisi metode:

• getResponse() dikembalikan dari Proxmox VE (data,kesalahan,...) Objek/Array
• responInError (bool): Berisi kesalahan dari Proxmox VE.
• getStatusCode() (int): Kode status respons HTTP.
• getReasonPhrase() (string): Frasa alasan yang biasanya dikirim oleh server bersama dengan kode status.
• isSuccessStatusCode() (bool) : Mendapatkan nilai yang menunjukkan apakah respons HTTP berhasil.
• getError() (string): Dapatkan kesalahan.
• getResponseHeaders() (string) : Mendapatkan header HTTP mentah yang terkait dengan respons ini.

Fitur utama

• Mudah dipelajari
• Tidak ada ketergantungan pada perpustakaan eksternal, hanya ikal asli
• Implementasinya menghormati struktur Api Proxmox VE
• Nama metode
• Setel ResponseType json, png
• Metode lengkap dihasilkan dari dokumentasi
• Komentari metode dan parameter apa pun
• Parameter yang diindeks misalnya [n] terstruktur dalam indeks dan nilai array
• Struktur pohon
  • $klien->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data
• Kembalikan data proxmox
• Hasil pengembalian
  • Meminta
  • Tanggapan
  • Status
• Tunggu tugas selesai tugas
  • tungguUntukTaskToFinish
  • tugasBerjalan
  • dapatkanExitStatusTask
• Metode akses langsung
  • mendapatkan
  • mengatur
  • membuat
  • menghapus
• Login kembali bool jika akses
• Kembalikan kelas Hasil informasi lebih lanjut
• Mengembalikan data objek/array
  • objek default dinonaktifkan dari client.setResultIsObject(false)
• Fungsi ringan ClientBase
• Formulir Proxmox VE 6.2 mendukung Api Token untuk pengguna
• Masuk dengan kata sandi satu kali untuk otentikasi dua faktor.
• Tetapkan Batas Waktu untuk Koneksi.

tanda api

Dari Proxmox VE versi 6.2 dimungkinkan untuk menggunakan token Api. Fitur ini mengizinkan mengeksekusi Api tanpa menggunakan pengguna dan kata sandi. Jika menggunakan Pemisahan Hak Istimewa saat membuat token api, ingatlah untuk menentukan izin. Format USER@REALM!TOKENID=TOKEN (Contoh penggunaan di bawah)

Instalasi

Disarankan instalasi menggunakan [Composer], jika belum memiliki [Composer] tunggu apa lagi?

Di root proyek Anda, jalankan yang berikut:

composer require Corsinvest/cv4pve-api-php

Atau tambahkan ini ke composer.json Anda

Penggunaan

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

Contoh permintaan versi keluaran:

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

Parameter yang diindeks diakhiri dengan '[n]' dalam dokumentasi (metode createVM dalam ide parameter Qemu) memerlukan array sedikit pun kunci dan nilai

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

Penggunaan dengan token API sebagai ganti nama pengguna/kata sandi

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