cv4pve api php

cv4pve-api-php

Proxmox VE Client API PHP

بروكسموكس VE API

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

Corsinvest for Proxmox VE Api Client  (Made in Italy)

حقوق الطبع والنشر والترخيص

حقوق الطبع والنشر: Corsinvest Srl للحصول على تفاصيل الترخيص، يرجى زيارة الترخيص

الدعم التجاري

يعد هذا البرنامج جزءًا من مجموعة أدوات تسمى أدوات cv4pve. إذا كنت تريد الدعم التجاري، قم بزيارة الموقع

عام

يتم إنشاء العميل من JSON Api على Proxmox VE.

تتيح لك مكتبة PHP 5.4+ هذه التفاعل مع خادم Proxmox عبر واجهة برمجة التطبيقات (API). يتم إنشاء العميل من JSON Api على Proxmox VE.

نتيجة

والنتيجة هي نتيجة الفصل وتحتوي على الأساليب:

• تم إرجاع getResponse() من كائن/صفيف Proxmox VE (بيانات، أخطاء،...).
• ResponseInError (bool): يحتوي على أخطاء من Proxmox VE.
• getStatusCode() (int): رمز الحالة لاستجابة HTTP.
• getReasonPhrase() (سلسلة): عبارة السبب التي عادةً ما يتم إرسالها بواسطة الخوادم مع رمز الحالة.
• isSuccessStatusCode() (bool): يحصل على قيمة تشير إلى ما إذا كانت استجابة HTTP ناجحة.
• getError () (سلسلة): الحصول على الخطأ.
• getResponseHeaders() (سلسلة): الحصول على رؤوس HTTP الأولية المرتبطة بهذه الاستجابة.

الميزات الرئيسية

• من السهل التعلم
• لا توجد مكتبة خارجية تبعية فقط حليقة أصلية
• يحترم التنفيذ بنية API الخاصة بـ Proxmox VE
• طريقة اسمه
• قم بتعيين نوع الاستجابة json، png
• الطريقة الكاملة الناتجة عن الوثائق
• التعليق على أي طريقة والمعلمات
• يتم تنظيم المعلمات المفهرسة على سبيل المثال [n] في فهرس الصفيف وقيمته
• هيكل الشجرة
  • $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data
• إرجاع البيانات بروكسموكس
• نتيجة العودة
  • طلب
  • إجابة
  • حالة
• انتظر انتهاء المهمة
  • waitForTaskToFinish
  • this.taskIsRunning
  • getExitStatusTask
• طريقة الوصول المباشر
  • يحصل
  • تعيين
  • يخلق
  • يمسح
• تسجيل الدخول العودة منطقية إذا الوصول
• إرجاع فئة النتيجة مزيد من المعلومات
• إرجاع بيانات الكائن/الصفيف
  • تعطيل الكائن الافتراضي من client.setResultIsObject (خطأ)
• وظيفة ClientBase لايت
• يدعم نموذج Proxmox VE 6.2 رمز Api للمستخدم
• قم بتسجيل الدخول باستخدام كلمة مرور لمرة واحدة للمصادقة الثنائية.
• اضبط مهلة الاتصال.

رمز واجهة برمجة التطبيقات

من الإصدار 6.2 من Proxmox VE من الممكن استخدام رمز Api. تسمح هذه الميزة بتنفيذ واجهة برمجة التطبيقات (API) دون استخدام المستخدم وكلمة المرور. في حالة استخدام فصل الامتياز عند إنشاء رمز واجهة برمجة التطبيقات، تذكر تحديد الإذن. تنسيق USER@REALM!TOKENID=TOKEN (مثال الاستخدام أدناه)

تثبيت

التثبيت الموصى به يستخدم [الملحن]، إذا لم يكن لديك [الملحن] فماذا تنتظر؟

في جذر مشروعك قم بتنفيذ ما يلي:

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]" في الوثائق (طريقة createVM في Qemu المعلمة ide) تتطلب صفيفًا مع مفتاح وقيمة

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