cv4pve api php

cv4pve-api-php

Клиентский API Proxmox VE PHP

Proxmox VE API

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

Corsinvest for Proxmox VE Api Client  (Made in Italy)

Авторские права и лицензия

Авторские права: Corsinvest Srl. Подробную информацию о лицензировании можно найти на странице ЛИЦЕНЗИЯ.

Коммерческая поддержка

Это программное обеспечение является частью набора инструментов под названием cv4pve-tools. Если вам нужна коммерческая поддержка, посетите сайт

Общий

Клиент генерируется из JSON Api на Proxmox VE.

Эта библиотека PHP 5.4+ позволяет вам взаимодействовать с вашим сервером Proxmox через API. Клиент генерируется из JSON Api на Proxmox VE.

Результат

Результатом является класс Result и содержащий методы:

• getResponse() возвращается из Proxmox VE (данные, ошибки,...) Объект/Массив
• responseInError (bool): Содержит ошибки Proxmox VE.
• getStatusCode() (int): код состояния HTTP-ответа.
• getReasonPhrase() (строка): фраза причины, которая обычно отправляется серверами вместе с кодом состояния.
• isSuccessStatusCode() (bool): получает значение, указывающее, был ли HTTP-ответ успешным.
• getError() (строка): Получить ошибку.
• getResponseHeaders() (строка): получает необработанные заголовки HTTP, связанные с этим ответом.

Основные особенности

• Легко учиться
• Нет зависимости от внешней библиотеки, только собственный Curl
• Реализация учитывает структуру API Proxmox VE.
• Имя метода
• Установить ResponseType json, png
• Полный метод, созданный из документации
• Комментируйте любой метод и параметры
• Индексированные параметры, например [n], структурированы в виде индекса и значения массива.
• Древовидная структура
  • $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data
• Возврат данных
• Возврат результата
  • Запрос
  • Ответ
  • Статус
• Подождать, завершить задачу
  • ждатьForTaskToFinish
  • задачаIsRunning
  • getExitStatusTask
• Метод прямого доступа
  • получать
  • набор
  • создавать
  • удалить
• Вход в систему возвращает bool, если есть доступ
• Класс возвращаемого результата подробнее
• Возвращать данные объекта/массива
  • отключение объекта по умолчанию из client.setResultIsObject(false)
• Функция ClientBase Lite
• Форма Proxmox VE 6.2 поддерживает токен API для пользователя
• Войдите с одноразовым паролем для двухфакторной аутентификации.
• Установите таймаут для соединения.

API-токен

Начиная с версии 6.2 Proxmox VE можно использовать токен 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]' (метод createVM в идентификаторе параметра Qemu), требуется массив с ключом и значением.

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