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