cv4pve api php 다운로드 - cv4pve api php 소스 코드 다운로드

cv4pve api php

기타 카테고리

v8.3.0

다운로드

cv4pve-api-php

Proxmox VE 클라이언트 API PHP

프록시목스 VE API

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

Corsinvest for Proxmox VE Api Client  (Made in Italy)

저작권 및 라이센스

저작권: Corsinvest Srl 라이선스에 대한 자세한 내용은 LICENSE를 참조하세요.

상업적 지원

이 소프트웨어는 cv4pve-tools라는 도구 모음의 일부입니다. 상업적 지원을 원하시면 사이트를 방문하세요

일반적인

클라이언트는 Proxmox VE의 JSON API에서 생성됩니다.

이 PHP 5.4+ 라이브러리를 사용하면 API를 통해 Proxmox 서버와 상호 작용할 수 있습니다. 클라이언트는 Proxmox VE의 JSON API에서 생성됩니다.

결과

결과는 Result 클래스이며 다음 메소드를 포함합니다.

Proxmox VE에서 반환된 getResponse() (데이터, 오류,...) 객체/배열
responseInError (bool) : Proxmox VE의 오류가 포함되어 있습니다.
getStatusCode() (int) : HTTP 응답의 상태 코드입니다.
getReasonPhrase() (문자열): 일반적으로 서버에서 상태 코드와 함께 전송하는 이유 구문입니다.
isSuccessStatusCode() (bool) : HTTP 응답이 성공했는지 여부를 나타내는 값을 가져옵니다.
getError() (string) : 오류를 가져옵니다.
getResponseHeaders() (string) : 이 응답과 관련된 원시 HTTP 헤더를 가져옵니다.

주요 기능

배우기 쉽다
종속성 없음 외부 라이브러리 전용 네이티브 컬
구현은 Proxmox VE의 Api 구조를 존중합니다.
명명된 메소드
ResponseType JSON 설정, png
문서에서 생성된 전체 메서드
모든 메소드 및 매개변수에 주석 달기
인덱스된 매개변수(예: [n])는 배열 인덱스 및 값으로 구성됩니다.
트리 구조
- $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data
근접 데이터 반환
결과 반환
- 요구
- 응답
- 상태
대기 작업 완료 작업
- 작업을 완료할 때까지 기다리세요.
- taskIsRunning
- getExitStatusTask
메소드 직접 액세스
- 얻다
- 세트
- 만들다
- 삭제
접속 시 로그인 반환 bool
반환 결과 클래스 추가 정보
객체/배열 데이터 반환
- client.setResultIsObject(false)에서 기본 개체 비활성화
ClientBase 라이트 기능
Form Proxmox VE 6.2는 사용자를 위한 Api 토큰을 지원합니다.
2단계 인증을 위해 일회용 비밀번호로 로그인하세요.
연결 시간 초과를 설정합니다.

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