cv4pve api php

cv4pve-api-php

Proxmox VE 用戶端 API PHP

Proxmox VE API

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

Corsinvest for Proxmox VE Api Client  (Made in Italy)

版權和許可

版權所有：Corsinvest Srl 有關許可詳細信息，請訪問許可證

商業支持

該軟體是名為 cv4pve-tools 的工具套件的一部分。如果您需要商業支持，請訪問該網站

一般的

客戶端是從 Proxmox VE 上的 JSON Api 產生的。

這個 PHP 5.4+ 函式庫允許您透過 API 與 Proxmox 伺服器互動。客戶端是從 Proxmox VE 上的 JSON Api 產生的。

結果

結果是類別Result並包含方法：

• getResponse()從 Proxmox VE 返回（數據，錯誤，...）物件/數組
• responseInError (bool) ：包含來自 Proxmox VE 的錯誤。
• getStatusCode() (int) ：HTTP 回應的狀態碼。
• getReasonPhrase() （字串）：通常由伺服器與狀態代碼一起發送的原因短語。
• isSuccessStatusCode() (bool) ：取得一個指示 HTTP 回應是否成功的值。
• getError() （字串）：取得錯誤。
• getResponseHeaders() （字串）：取得與此回應關聯的原始 HTTP 標頭。

主要特點

• 簡單易學
• 不依賴外部函式庫僅原生curl
• 實現尊重 Proxmox VE 的 Api 結構
• 方法命名為
• 設定回應類型 json, png
• 從文件產生的完整方法
• 註解任何方法和參數
• 索引參數，例如 [n] 由數組索引和值構成
• 樹狀結構
  • $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data
• 回傳資料proxmox
• 回傳結果
  • 要求
  • 回覆
  • 地位
• 等待任務完成任務
  • 等待任務完成
  • 任務正在運行
  • 取得退出狀態任務
• 方法直接訪問
  • 得到
  • 放
  • 創造
  • 刪除
• 登入如果訪問則回傳bool
• 傳回結果類別更多信息
• 傳回物件/陣列數據
  • client.setResultIsObject(false) 停用預設對象
• ClientBase精簡版功能
• Form Proxmox VE 6.2 支援使用者的 Api 令牌
• 使用一次性密碼登入以進行雙重身份驗證。
• 設定連接逾時。

API令牌

從 Proxmox VE 6.2 版本開始，可以使用 Api 令牌。此功能允許在不使用使用者名稱和密碼的情況下執行 Api。如果在建立 api 令牌時使用權限分離，請記得在權限中指定。格式USER@REALM!TOKENID=TOKEN （使用範例如下）

安裝

建議安裝使用【Composer】，如果你沒有【Composer】還等什麼呢？

在專案的根目錄中執行以下命令：

composer require Corsinvest/cv4pve-api-php

或將其添加到您的composer.json

用法

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

輸出版本請求範例：

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

文件中以「[n]」索引結束的參數（Qemu參數ide中的方法createVM）需要陣列惠特鍵和值

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

使用 API 令牌代替使用者名稱/密碼

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