hallofcode / forkedzzantaresproxmoxve
一个简单的PHP 5.5+ Proxmox API客户端。
Requires
- php: >=5.5.0
- lib-curl: *
- guzzlehttp/guzzle: ~6.0 || ~7.0
Requires (Dev)
- phpunit/phpunit: ~4.1
- squizlabs/php_codesniffer: 1.*
This package is auto-updated.
Last update: 2024-09-30 01:46:44 UTC
README
这个 PHP 5.5+ 库允许您通过API与您的Proxmox服务器交互。
我不再积极维护这个库了(我已经放弃了PHP),但是 API非常稳定,如果它不符合您的需求,请查看分支或最好创建一个PR来添加您缺少的功能,如果您有兴趣,我可以将项目转让给您。
需要PHP 5.3库版本吗? 通过发布 搜索适合您需求的版本,我推荐使用 2.1.1 版本。
安装
建议使用 Composer 进行安装,如果您还没有 Composer,您在等什么?
在您项目的根目录中执行以下操作
$ composer require zzantares/proxmoxve ~4.0
或者将其添加到您的 composer.json 文件中
{
"require": {
"zzantares/proxmoxve": "~4.0"
}
}
然后执行安装
$ composer install --no-dev
使用方法
<?php // Require the autoloader require_once 'vendor/autoload.php'; // Use the library namespace use ProxmoxVE\Proxmox; // Create your credentials array $credentials = [ 'hostname' => 'proxmox.server.com', // Also can be an IP 'username' => 'root', 'password' => 'secret', ]; // realm and port defaults to 'pam' and '8006' but you can specify them like so $credentials = [ 'hostname' => 'proxmox.server.com', 'username' => 'root', 'password' => 'secret', 'realm' => 'pve', 'port' => '9009', ]; // Then simply pass your credentials when creating the API client object. $proxmox = new Proxmox($credentials); $allNodes = $proxmox->get('/nodes'); print_r($allNodes);
示例输出
Array ( [data] => Array ( [0] => Array ( [disk] => 2539465464 [cpu] => 0.031314446882002 [maxdisk] => 30805066770 [maxmem] => 175168446464 [node] => mynode1 [maxcpu] => 24 [level] => [uptime] => 139376 [id] => node/mynode1 [type] => node [mem] => 20601992182 ) ) )
使用MailGateway API
这个库也可以用来通过更改凭证数组中的 system 条目与 Proxmox MailGateway API 通信。
<?php $credentials = [ 'hostname' => 'proxmox.server.com', // Also can be an IP 'username' => 'root', 'password' => 'secret', 'system' => 'pmg', // Defaults to 'pve' for the PVE API. Use 'pmg' for the PMG API. ];
想了解更多技巧吗?
查看我们的 wiki。
文档
在您的Proxmox客户端对象上,您可以使用 get()、create()、set() 和 delete() 函数来操作在 PVE2 API 文档 中指定的所有资源,参数作为关联数组中的第二个参数传递。
我如何与哪些资源或路径交互以及如何操作?
在您的Proxmox服务器上,您可以使用 pvesh CLI工具 来管理所有pve资源,您可以使用这个库以与使用pvesh工具相同的方式使用它。例如,您可以运行 pvesh,然后,屏幕消息应该显示,您可以输入 help [path] [--verbose] 来查看如何使用路径以及应该传递给它的参数。请确保在Proxmox wiki上阅读有关pvesh CLI工具 的信息。
Proxmox API是如何工作的?
请参阅ProxmoxVE API 文章,该文章位于Proxmox wiki。
我觉得你藏着一些酷技巧!我需要更多文档!
请参阅项目的 wiki 获取更详细的文档,它都在那里,我发誓...我想。
许可
该项目在MIT许可下发布。有关详细信息,请参阅捆绑的 LICENSE 文件。
想贡献吗?
谢谢!请查看CONTRIBUTING,您可以轻松设置开发环境,让您快速开始!