cv4pve api php

cv4pve-api-php

API do cliente Proxmox VE PHP

API Proxmox VE

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

Corsinvest for Proxmox VE Api Client  (Made in Italy)

Direitos autorais e licença

Direitos autorais: Corsinvest Srl Para detalhes de licenciamento, visite LICENSE

Suporte Comercial

Este software faz parte de um conjunto de ferramentas chamado cv4pve-tools. Se desejar suporte comercial, visite o site

Em geral

O cliente é gerado a partir de uma API JSON no Proxmox VE.

Esta biblioteca PHP 5.4+ permite que você interaja com seu servidor Proxmox via API. O cliente é gerado a partir de uma API JSON no Proxmox VE.

Resultado

O resultado é a classe Result e contém métodos:

• getResponse() retornado do Proxmox VE (dados, erros,...) Objeto/matriz
• responseInError (bool): Contém erros do Proxmox VE.
• getStatusCode() (int): Código de status da resposta HTTP.
• getReasonPhrase() (string): A frase de motivo que normalmente é enviada pelos servidores junto com o código de status.
• isSuccessStatusCode() (bool): Obtém um valor que indica se a resposta HTTP foi bem-sucedida.
• getError() (string): Obtém erro.
• getResponseHeaders() (string): Obtém os cabeçalhos HTTP brutos associados a esta resposta.

Principais características

• Fácil de aprender
• Sem dependência de biblioteca externa, apenas curl nativo
• A implementação respeita a estrutura Api do Proxmox VE
• Método nomeado
• Definir ResponseType json, png
• Método completo gerado a partir da documentação
• Comente qualquer método e parâmetros
• Parâmetros indexados, por exemplo, [n] são estruturados em índice e valor de array
• Estrutura de árvore
  • $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->dados
• Retornar dados proxmox
• Resultado de retorno
  • Solicitar
  • Resposta
  • Status
• Aguarde tarefa terminar tarefa
  • waitForTaskToFinish
  • tarefaIsRunning
  • getExitStatusTask
• Método de acesso direto
  • pegar
  • definir
  • criar
  • excluir
• Login return bool se acesso
• Classe de resultado de retorno mais informações
• Retornar dados de objeto/array
  • objeto padrão desabilitado em client.setResultIsObject (false)
• Função ClientBase Lite
• Formulário Proxmox VE 6.2 suporta token de API para usuário
• Faça login com senha única para autenticação de dois fatores.
• Defina o tempo limite para a conexão.

Token de API

A partir da versão 6.2 do Proxmox VE é possível utilizar token Api. Este recurso permite executar API sem usar usuário e senha. Se estiver usando a separação de privilégios ao criar o token da API, lembre-se de especificar a permissão. Formato USER@REALM!TOKENID=TOKEN (exemplo de uso abaixo)

Instalação

A instalação recomendada é usando o [Composer], se você não tem o [Composer] o que está esperando?

Na raiz do seu projeto execute o seguinte:

composer require Corsinvest/cv4pve-api-php

Ou adicione isso ao seu composer.json

Uso

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

Exemplo de solicitação de versão de saída:

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

O parâmetro indexado termina com '[n]' na documentação (método createVM no parâmetro Qemu ide) requer array com chave e valor

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

Uso com token de API em vez de nome de usuário/senha

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