jefersonflus/proxmox-php-sdk

Proxmox PHP SDK

v1.0.0 2026-02-15 04:28 UTC

Requires

• php-curl-class/php-curl-class: ^11.0

MIT

• Jeferson

• php
• api
• Proxmox
• PVE

README

Proxmox PHP SDK

Requirements

Minimum

• PHP 7.4
• PHP extension ext-curl
• Composer 2.x

Recommended

• PHP 8.2 or newer
• Composer 2.7 or newer
• Node.js 20 or newer (for composer validate:apidoc)

Table of Contents

• Proxmox PHP SDK
  • Requirements
    • Minimum
    • Recommended
  • Table of Contents
  • Installation
  • Development
  • Usage
    • Quick Usage
    • Use API Token
    • Example
    • Create LXC container
    • Delete LXC container
    • Create VM
    • Delete VM
  • Request
  • Access
  • Domains
  • Groups
  • Roles
  • Users
  • User Tokens
  • TFA
  • Permissions
  • Ticket
  • Version
  • Cluster
  • Backup
  • Backup Info
  • Bulk Action
  • Config
  • Firewall
  • HA
  • Replication
  • Cluster Ceph
  • Jobs
  • Metrics
  • Cluster Advanced
  • Pools
  • Storage
  • Nodes
  • Capabilities
  • Apt
  • Certificates
  • Ceph
  • Disks
  • Nodes Firewall
  • Lxc
  • Network
  • Qemu
  • Nodes Replication
  • Scan
  • SDN
  • Hardware
  • Metadata Queries
  • Service
  • Nodes Storage
  • Tasks
  • Vzdump

Installation

To install Proxmox PHP SDK, simply:

composer require jefersonflus/proxmox-php-sdk @dev

Development

composer lint
composer test
composer validate:apidoc

Release/versioning policy: RELEASE.md

Usage

Request exposes static methods. Access, Cluster, Nodes, Pools, Storage, and Version expose instance methods.

Quick Usage

require __DIR__ . '/vendor/autoload.php'; // Autoload files using Composer autoload
use Proxmox\Request;

$configure = [
    'hostname' => '0.0.0.0',
    'username' => 'root',
    'password' => 'password'
];
Request::Login($configure); // Login ..

// Request($path, array $params = null, $method="GET")
print_r( Request::Request('/nodes', null, 'GET') ); // List Nodes

Use API Token

require __DIR__ . '/vendor/autoload.php'; // Autoload files using Composer autoload
use Proxmox\Request;
use Proxmox\Nodes;

$configure = [
    'hostname' => '0.0.0.0',
    'username' => 'root',
    'token_name' => 'apitoken',
    'token_value' => '00000000-0000-0000-0000-000000000000'
];
Request::Login($configure); // Login ..
$nodes = new Nodes();
print_r( $nodes->listNodes() ); // List Nodes

Example

require __DIR__ . '/vendor/autoload.php'; // Autoload files using Composer autoload
use Proxmox\Request;
use Proxmox\Access;
use Proxmox\Cluster;
use Proxmox\Nodes;
use Proxmox\Pools;
use Proxmox\Storage;
use Proxmox\Version;

$configure = [
    'hostname' => '0.0.0.0',
    'username' => 'root',
    'password' => 'password',
];
Request::Login($configure); // Login ..
$access = new Access();
$cluster = new Cluster();
$nodes = new Nodes();
$pools = new Pools();
$storage = new Storage();
$version = new Version();

print_r( $nodes->listNodes() ); // List Nodes

Create LXC container

require __DIR__ . '/vendor/autoload.php'; // Autoload files using Composer autoload
use Proxmox\Request;
use Proxmox\Cluster;
use Proxmox\Nodes;

$configure = [
  'hostname' => '0.0.0.0',
  'username' => 'root',
  'password' => 'password',
];
Request::Login($configure); // Login ..
$cluster = new Cluster();
$nodes = new Nodes();

# Create container
$nextId = $cluster->nextVmid(); // get next vmid
$create = [
  'vmid'        => $nextId->data,
  'cores'       => 1,
  'hostname'    => 'testApi',
  'rootfs'      => 'local:8',
  'memory'      => 512,
  'swap'        => 512,
  'ostemplate'  => 'local:vztmpl/ubuntu-16.04-standard_16.04-1_amd64.tar.gz',
  'net0'        => 'bridge=vmbr0,hwaddr=00:00:00:00:00:00,name=eth0,ip=0.0.0.0/32,gw=0.0.0.0'
];
# Get first node name.
$firstNode = $nodes->listNodes()->data[0]->node;
print_r( $nodes->createLxc($firstNode, $create) );
// print_r( $nodes->createLxc('Name_Nodes', $create) );

Delete LXC container

require __DIR__ . '/vendor/autoload.php'; // Autoload files using Composer autoload
use Proxmox\Request;
use Proxmox\Nodes;

$configure = [
  'hostname' => '0.0.0.0',
  'username' => 'root',
  'password' => 'password',
];
Request::Login($configure); // Login ..
$nodes = new Nodes();

# Get first node name.
$firstNode = $nodes->listNodes()->data[0]->node;
# Delete container
$vmid = 106;
print_r( $nodes->deleteLxc($firstNode, $vmid) );
// print_r( $nodes->deleteLxc('Name_Nodes', $vmid) );

Create VM

require __DIR__ . '/vendor/autoload.php'; // Autoload files using Composer autoload
use Proxmox\Request;
use Proxmox\Cluster;
use Proxmox\Nodes;

$configure = [
  'hostname' => '0.0.0.0',
  'username' => 'root',
  'password' => 'password',
];
Request::Login($configure); // Login ..
$cluster = new Cluster();
$nodes = new Nodes();

# Create VM
$nextId = $cluster->nextVmid(); // get next vmid
$create = [
  'vmid'        => $nextId->data,
  'cores'       => 1,
  'name'        => 'testApi',
  'scsi0'       => 'local:32,format=qcow2'
];
# Get first node name.
$firstNode = $nodes->listNodes()->data[0]->node;
print_r( $nodes->createQemu($firstNode, $create) );
// print_r( $nodes->createQemu('Name_Nodes', $create) );

Delete VM

require __DIR__ . '/vendor/autoload.php'; // Autoload files using Composer autoload
use Proxmox\Request;
use Proxmox\Nodes;

$configure = [
  'hostname' => '0.0.0.0',
  'username' => 'root',
  'password' => 'password',
];
Request::Login($configure); // Login ..
$nodes = new Nodes();

# Get first node name.
$firstNode = $nodes->listNodes()->data[0]->node;
# Delete VM
$vmid = 104;
print_r( $nodes->deleteQemu($firstNode, $vmid) );
// print_r( $nodes->deleteQemu('Name_Nodes', $vmid) );

Request

Request::Login(array $configure, $verifySSL = false, $verifyHost = false)
Request::Request($path, array $params = null, $method="GET")

For the method list below, assume these instances:

use Proxmox\Access;
use Proxmox\Cluster;
use Proxmox\Nodes;
use Proxmox\Pools;
use Proxmox\Storage;
use Proxmox\Version;

$access = new Access();
$cluster = new Cluster();
$nodes = new Nodes();
$pools = new Pools();
$storage = new Storage();
$version = new Version();

Access

$access->Access()
$access->Acl()
$access->updateAcl($data = array())
$access->Openid()
$access->openidAuthUrl($data = array())
$access->openidLogin($data = array())
$access->Permissions($data = array())
$access->Ticket($data = array())
$access->createTicket($data = array())
$access->createVncTicket($data = array())

Domains

$access->Domains()
$access->addDomain($data = array())
$access->domainsRealm($realm)
$access->updateDomain($realm, $data = array())
$access->deleteDomain($realm)
$access->syncDomain($realm, $data = array())

Groups

$access->Groups()
$access->createGroup($data = array())
$access->GroupId($groupid)
$access->updateGroup($groupid, $data = array())
$access->deleteGroup($groupid)

Roles

$access->Roles()
$access->createRole($data = array())
$access->RoleId($roleid)
$access->updateRole($roleid, $data = array())
$access->deleteRole($roleid)

Users

$access->Users()
$access->createUser($data = array())
$access->getUser($userid)
$access->updateUser($userid, $data = array())
$access->deleteUser($userid)
$access->changeUserPassword($data = array())
$access->userTfaEntries($userid)
$access->unlockUserTfa($userid, $data = array())

User Tokens

$access->userTokens($userid)
$access->userToken($userid, $tokenid)
$access->createUserToken($userid, $tokenid, $data = array())
$access->updateUserToken($userid, $tokenid, $data = array())
$access->deleteUserToken($userid, $tokenid)

TFA

$access->Tfa()
$access->TfaUser($userid)
$access->createTfaUser($userid, $data = array())
$access->TfaUserId($userid, $id)
$access->updateTfaUserId($userid, $id, $data = array())
$access->deleteTfaUserId($userid, $id)

Permissions

$access->Permissions($data = array())

Ticket

$access->Ticket($data = array())
$access->createTicket($data = array())

Version

$version->getVersion()

Cluster

$cluster->Cluster()
$cluster->Log($max = null)
$cluster->nextVmid($vmid = null)
$cluster->Options()
$cluster->setOptions($data = array())
$cluster->Resources($type = null)
$cluster->Status()
$cluster->Tasks()

Backup

$cluster->ListBackup()
$cluster->createBackup($data = array())
$cluster->BackupId($id)
$cluster->updateBackup($id, $data = array())
$cluster->deleteBackup($id)
$cluster->backupIncludedVolumes($id)

Backup Info

$cluster->BackupInfo()
$cluster->backupInfoNotBackedUp()

Bulk Action

$cluster->BulkAction()
$cluster->BulkActionGuest()
$cluster->bulkActionGuestStart($data = array())
$cluster->bulkActionGuestShutdown($data = array())
$cluster->bulkActionGuestSuspend($data = array())
$cluster->bulkActionGuestMigrate($data = array())

Config

$cluster->Config()
$cluster->createConfig($data = array())
$cluster->configApiVersion()
$cluster->configJoin()
$cluster->createConfigJoin($data = array())
$cluster->configQdevice()
$cluster->listConfigNodes()
$cluster->createConfigNode($node, $data = array())
$cluster->deleteConfigNode($node)
$cluster->configTotem()

Firewall

$cluster->Firewall()
$cluster->firewallListAliases()
$cluster->createFirewallAliase($data = array())
$cluster->getFirewallAliasesName($name)
$cluster->updateFirewallAliase($name, $data = array())
$cluster->removeFirewallAliase($name)
$cluster->firewallListGroups()
$cluster->createFirewallGroup($data = array())
$cluster->firewallGroupsGroup($group)
$cluster->createRuleFirewallGroup($group, $data = array())
$cluster->removeFirewallGroup($group)
$cluster->firewallGroupsGroupPos($group, $pos)
$cluster->setFirewallGroupPos($group, $pos, $data = array())
$cluster->removeFirewallGroupPos($group, $pos)
$cluster->firewallListIpset()
$cluster->createFirewallIpset($data = array())
$cluster->firewallIpsetName($name)
$cluster->firewallIpsetNameCidr($name, $cidr)
$cluster->updateFirewallIpsetNameCidr($name, $cidr, $data = array())
$cluster->deleteFirewallIpsetNameCidr($name, $cidr)
$cluster->addFirewallIpsetName($name, $data = array())
$cluster->deleteFirewallIpsetName($name)
$cluster->firewallListRules()
$cluster->createFirewallRules($data = array())
$cluster->firewallRulesPos($pos)
$cluster->setFirewallRulesPos($pos, $data = array())
$cluster->deleteFirewallRulesPos($pos)
$cluster->firewallListMacros()
$cluster->firewallListOptions()
$cluster->setFirewallOptions($data = array())
$cluster->firewallListRefs()

HA

$cluster->Ha()
$cluster->getHaGroups()
$cluster->HaGroups($group)
$cluster->createHaGroup($data = array())
$cluster->updateHaGroup($group, $data = array())
$cluster->deleteHaGroup($group)
$cluster->HaResources()
$cluster->createHaResource($data = array())
$cluster->HaResource($sid)
$cluster->updateHaResource($sid, $data = array())
$cluster->deleteHaResource($sid, $data = array())
$cluster->migrateHaResource($sid, $data = array())
$cluster->relocateHaResource($sid, $data = array())
$cluster->HaRules($resource = null, $type = null)
$cluster->createHaRule($data = array())
$cluster->HaRule($rule)
$cluster->updateHaRule($rule, $data = array())
$cluster->deleteHaRule($rule)
$cluster->HaStatus()
$cluster->HaStatusCurrent()
$cluster->HaStatusManagerStatus()

Replication

$cluster->Replication()
$cluster->createReplication($data = array())
$cluster->replicationId($id)
$cluster->updateReplication($id, $data = array())
$cluster->deleteReplication($id)

Cluster Ceph

$cluster->Ceph()
$cluster->CephMetadata($scope = null)
$cluster->CephStatus()
$cluster->CephFlags()
$cluster->setCephFlags($data = array())
$cluster->CephFlag($flag)
$cluster->setCephFlag($flag, $data = array())

Jobs

$cluster->Jobs()
$cluster->RealmSyncJobs()
$cluster->RealmSyncJob($id)
$cluster->createRealmSyncJob($id, $data = array())
$cluster->updateRealmSyncJob($id, $data = array())
$cluster->deleteRealmSyncJob($id)
$cluster->jobsScheduleAnalyze($schedule = null, $starttime = null, $iterations = null)

Metrics

$cluster->Metrics()
$cluster->MetricsExport($data = array())
$cluster->MetricsServer()
$cluster->MetricsServerId($id)
$cluster->createMetricsServer($id, $data = array())
$cluster->updateMetricsServer($id, $data = array())
$cluster->deleteMetricsServer($id)

Cluster Advanced

$cluster->Acme()
$cluster->Mapping()
$cluster->Notifications()
$cluster->Sdn()
$cluster->acmeAccount()
$cluster->acmeAccountName()
$cluster->acmeChallengeSchema()
$cluster->acmeDirectories()
$cluster->acmeMeta()
$cluster->acmePluginId()
$cluster->acmePlugins()
$cluster->acmeTos()
$cluster->createAcmeAccount()
$cluster->createAcmePlugin()
$cluster->createMappingDir()
$cluster->createMappingPci()
$cluster->createMappingUsb()
$cluster->createNotificationEndpointGotify()
$cluster->createNotificationEndpointSendmail()
$cluster->createNotificationEndpointSmtp()
$cluster->createNotificationEndpointWebhook()
$cluster->createNotificationMatcher()
$cluster->createSdnController()
$cluster->createSdnDns()
$cluster->createSdnFabric()
$cluster->createSdnFabricNode()
$cluster->createSdnIpam()
$cluster->createSdnLock()
$cluster->createSdnVnet()
$cluster->createSdnVnetFirewallRule()
$cluster->createSdnVnetIp()
$cluster->createSdnVnetSubnet()
$cluster->createSdnZone()
$cluster->deleteAcmeAccountName()
$cluster->deleteAcmePluginId()
$cluster->deleteMappingDirId()
$cluster->deleteMappingPciId()
$cluster->deleteMappingUsbId()
$cluster->deleteNotificationEndpointGotifyName()
$cluster->deleteNotificationEndpointSendmailName()
$cluster->deleteNotificationEndpointSmtpName()
$cluster->deleteNotificationEndpointWebhookName()
$cluster->deleteNotificationMatcherName()
$cluster->deleteSdnController()
$cluster->deleteSdnDnsId()
$cluster->deleteSdnFabricId()
$cluster->deleteSdnFabricNode()
$cluster->deleteSdnIpam()
$cluster->deleteSdnLock()
$cluster->deleteSdnVnet()
$cluster->deleteSdnVnetFirewallRulePos()
$cluster->deleteSdnVnetIp()
$cluster->deleteSdnVnetSubnet()
$cluster->deleteSdnZone()
$cluster->mappingDir()
$cluster->mappingDirId()
$cluster->mappingPci()
$cluster->mappingPciId()
$cluster->mappingUsb()
$cluster->mappingUsbId()
$cluster->notificationEndpointGotifyName()
$cluster->notificationEndpointSendmailName()
$cluster->notificationEndpointSmtpName()
$cluster->notificationEndpointWebhookName()
$cluster->notificationEndpoints()
$cluster->notificationEndpointsGotify()
$cluster->notificationEndpointsSendmail()
$cluster->notificationEndpointsSmtp()
$cluster->notificationEndpointsWebhook()
$cluster->notificationMatcherFieldValues()
$cluster->notificationMatcherFields()
$cluster->notificationMatcherName()
$cluster->notificationMatchers()
$cluster->notificationTargets()
$cluster->sdnController()
$cluster->sdnControllers()
$cluster->sdnDns()
$cluster->sdnDnsId()
$cluster->sdnFabric()
$cluster->sdnFabricId()
$cluster->sdnFabricNode()
$cluster->sdnFabricNodes()
$cluster->sdnFabricNodesFabricId()
$cluster->sdnFabrics()
$cluster->sdnFabricsAll()
$cluster->sdnIpam()
$cluster->sdnIpamStatus()
$cluster->sdnIpams()
$cluster->sdnRollback()
$cluster->sdnVnet()
$cluster->sdnVnetFirewall()
$cluster->sdnVnetFirewallOptions()
$cluster->sdnVnetFirewallRulePos()
$cluster->sdnVnetFirewallRules()
$cluster->sdnVnetSubnet()
$cluster->sdnVnetSubnets()
$cluster->sdnVnets()
$cluster->sdnZone()
$cluster->sdnZones()
$cluster->setSdn()
$cluster->testNotificationTarget()
$cluster->updateAcmeAccountName()
$cluster->updateAcmePluginId()
$cluster->updateMappingDirId()
$cluster->updateMappingPciId()
$cluster->updateMappingUsbId()
$cluster->updateNotificationEndpointGotifyName()
$cluster->updateNotificationEndpointSendmailName()
$cluster->updateNotificationEndpointSmtpName()
$cluster->updateNotificationEndpointWebhookName()
$cluster->updateNotificationMatcherName()
$cluster->updateSdnController()
$cluster->updateSdnDnsId()
$cluster->updateSdnFabricId()
$cluster->updateSdnFabricNode()
$cluster->updateSdnIpam()
$cluster->updateSdnVnet()
$cluster->updateSdnVnetFirewallOptions()
$cluster->updateSdnVnetFirewallRulePos()
$cluster->updateSdnVnetIp()
$cluster->updateSdnVnetSubnet()
$cluster->updateSdnZone()

Pools

$pools->Pools()
$pools->getPool($poolid)
$pools->UpdatePool($poolid_or_data = null, $data = array())
$pools->UpdatePoolById($poolid, $data = array())
$pools->CreatePool($data = array())
$pools->DeletePool($poolid)
$pools->DeletePools($data = array())

Storage

$storage->Storage($type = null)
$storage->createStorage($data = array())
$storage->getStorage($storage)
$storage->updateStorage($storage, $data = array())
$storage->deleteStorage($storage)

Nodes

$nodes->listNodes()
$nodes->Node($node)
$nodes->nodeStatus($node)
$nodes->nodeConfig($node)
$nodes->updateNodeConfig($node, $data = array())
$nodes->Aplinfo($node)
$nodes->downloadTemplate($node, $data = array())
$nodes->Dns($node)
$nodes->setDns($node, $data = array())
$nodes->Execute($node, $data = array())
$nodes->MigrateAll($node, $data = array())
$nodes->Netstat($node)
$nodes->Report($node)
$nodes->Hosts($node)
$nodes->createHosts($node, $data = array())
$nodes->Journal($node, $data = array())
$nodes->Rrd($node, $ds = null, $timeframe = null)
$nodes->Rrddata($node, $timeframe = null)
$nodes->SpiceShell($node, $data = array())
$nodes->StartAll($node, $data = array())
$nodes->SuspendAll($node, $data = array())
$nodes->WakeOnLan($node, $data = array())
$nodes->Termproxy($node, $data = array())
$nodes->Reboot($node, $data = array())
$nodes->StopAll($node, $data = array())
$nodes->Subscription($node)
$nodes->updateSubscription($node, $data = array())
$nodes->setSubscription($node, $data = array())
$nodes->deleteSubscription($node)
$nodes->Syslog($node, $limit = null, $start = null, $since = null, $until = null)
$nodes->Time($node)
$nodes->setTime($node, $data = array())
$nodes->Version($node)
$nodes->createVNCShell($node, $data = array())
$nodes->VNCWebSocket($node, $port = null, $vncticket = null)

Capabilities

$nodes->Capabilities($node)
$nodes->capabilitiesQemu($node)
$nodes->capabilitiesQemuCpu($node)
$nodes->capabilitiesQemuCpuFlags($node)
$nodes->capabilitiesQemuMachines($node)
$nodes->capabilitiesQemuMigration($node)

Apt

$nodes->Apt($node)
$nodes->AptVersions($node)
$nodes->aptRepositories($node)
$nodes->createAptRepository($node, $data = array())
$nodes->updateAptRepositories($node, $data = array())
$nodes->updateApt($node, $data = array())
$nodes->AptChangelog($node, $name = null)
$nodes->AptUpdate($node)
$nodes->createAptUpdate($node, $data = array())

Certificates

$nodes->Certificates($node)
$nodes->certificatesInfo($node)
$nodes->certificatesAcme($node)
$nodes->createCertificatesAcmeCertificate($node, $data = array())
$nodes->updateCertificatesAcmeCertificate($node, $data = array())
$nodes->deleteCertificatesAcmeCertificate($node)
$nodes->createCertificatesCustom($node, $data = array())
$nodes->deleteCertificatesCustom($node)

Ceph

$nodes->Ceph($node)
$nodes->CephFlags($node)
$nodes->setCephFlags($node, $flag, $data = array())
$nodes->unsetCephFlags($node, $flag)
$nodes->CephMgr($node)
$nodes->createCephMgr($node, $data = array())
$nodes->destroyCephMgr($node, $id)
$nodes->CephMon($node)
$nodes->createCephMon($node, $data = array())
$nodes->destroyCephMon($node, $monid)
$nodes->CephMds($node)
$nodes->createCephMds($node, $name, $data = array())
$nodes->destroyCephMds($node, $name)
$nodes->CephFs($node)
$nodes->createCephFs($node, $name, $data = array())
$nodes->CephOsd($node)
$nodes->createCephOsd($node, $data = array())
$nodes->destroyCephOsd($node, $osdid)
$nodes->CephOsdId($node, $osdid)
$nodes->CephOsdMetadata($node, $osdid)
$nodes->CephOsdLvInfo($node, $osdid)
$nodes->CephOsdScrub($node, $osdid, $data = array())
$nodes->CephOsdIn($node, $osdid, $data = array())
$nodes->CephOsdOut($node, $osdid, $data = array())
$nodes->getCephPools($node)
$nodes->createCephPool($node, $data = array())
$nodes->destroyCephPool($node, $name = null, $data = array())
$nodes->CephPool($node, $name)
$nodes->updateCephPool($node, $name, $data = array())
$nodes->CephPoolStatus($node, $name)
$nodes->CephConfig($node)
$nodes->CephConfigDb($node)
$nodes->CephConfigRaw($node)
$nodes->CephConfigValue($node, $data = array())
$nodes->CephCmdSafety($node)
$nodes->CephCrush($node)
$nodes->CephDisks($node)
$nodes->createCephInit($node, $data = array())
$nodes->CephRestart($node, $data = array())
$nodes->CephLog($node, $limit = null, $start = null)
$nodes->CephRules($node)
$nodes->CephStart($node, $data = array())
$nodes->CephStop($node, $data = array())
$nodes->CephStatus($node)

Disks

$nodes->getDisks($node)
$nodes->Disk($node, $data = array())
$nodes->disksList($node)
$nodes->disksSmart($node, $disk = null)
$nodes->disksDirectory($node, $data = array())
$nodes->createDisksDirectory($node, $data = array())
$nodes->deleteDisksDirectoryName($node, $name)
$nodes->disksLvm($node, $data = array())
$nodes->createDisksLvm($node, $data = array())
$nodes->deleteDisksLvmName($node, $name)
$nodes->disksLvmthin($node, $data = array())
$nodes->createDisksLvmthin($node, $data = array())
$nodes->deleteDisksLvmthinName($node, $name)
$nodes->disksZfs($node, $data = array())
$nodes->disksZfsName($node, $name, $data = array())
$nodes->createDisksZfs($node, $data = array())
$nodes->deleteDisksZfsName($node, $name)
$nodes->disksWipedisk($node, $data = array())

Nodes Firewall

$nodes->Firewall($node)
$nodes->firewallRules($node)
$nodes->createFirewallRule($node, $data = array())
$nodes->firewallRulesPos($node, $pos)
$nodes->setFirewallRulePos($node, $pos, $data = array())
$nodes->deleteFirewallRulePos($node, $pos)
$nodes->firewallRulesLog($node)
$nodes->firewallRulesOptions($node)
$nodes->setFirewallRuleOptions($node, $data = array())

Lxc

$nodes->Lxc($node)
$nodes->createLxc($node, $data = array())
$nodes->LxcVmid($node, $vmid)
$nodes->deleteLxc($node, $vmid)
$nodes->lxcFirewall($node, $vmid)
$nodes->lxcFirewallAliases($node, $vmid)
$nodes->createLxcFirewallAliase($node, $vmid, $data = array())
$nodes->lxcFirewallAliasesName($node, $vmid, $name)
$nodes->updateLxcFirewallAliaseName($node, $vmid, $name, $data = array())
$nodes->deleteLxcFirewallAliaseName($node, $vmid, $name)
$nodes->lxcFirewallIpset($node, $vmid)
$nodes->createLxcFirewallIpset($node, $vmid, $data = array())
$nodes->lxcFirewallIpsetName($node, $vmid, $name)
$nodes->addLxcFirewallIpsetName($node, $vmid, $name, $data = array())
$nodes->deleteLxcFirewallIpsetName($node, $vmid, $name)
$nodes->lxcFirewallIpsetNameCidr($node, $vmid, $name, $cidr)
$nodes->updateLxcFirewallIpsetNameCidr($node, $vmid, $name, $cidr, $data = array())
$nodes->deleteLxcFirewallIpsetNameCidr($node, $vmid, $name, $cidr)
$nodes->lxcFirewallRules($node, $vmid)
$nodes->createLxcFirewallRules($node, $vmid, $data = array())
$nodes->lxcFirewallRulesPos($node, $vmid, $pos)
$nodes->setLxcFirewallRulesPos($node, $vmid, $pos, $data = array())
$nodes->deleteLxcFirewallRulesPos($node, $vmid, $pos)
$nodes->lxcFirewallLog($node, $vmid, $limit = null, $start = null)
$nodes->lxcFirewallOptions($node, $vmid)
$nodes->setLxcFirewallOptions($node, $vmid, $data = array())
$nodes->lxcSnapshot($node, $vmid)
$nodes->createLxcSnapshot($node, $vmid, $data = array())
$nodes->lxcSnapname($node, $vmid, $snapname)
$nodes->deleteLxcSnapshot($node, $vmid, $snapname)
$nodes->lxcSnapnameConfig($node, $vmid, $snapname)
$nodes->lxcSnapshotConfig($node, $vmid, $snapname, $data = array())
$nodes->lxcSnapshotRollback($node, $vmid, $snapname, $data = array())
$nodes->lxcStatus($node, $vmid)
$nodes->lxcCurrent($node, $vmid)
$nodes->lxcResume($node, $vmid, $data = array())
$nodes->lxcShutdown($node, $vmid, $data = array())
$nodes->lxcStart($node, $vmid, $data = array())
$nodes->lxcStop($node, $vmid, $data = array())
$nodes->lxcReboot($node, $vmid, $data = array())
$nodes->lxcSuspend($node, $vmid, $data = array())
$nodes->lxcClone($node, $vmid, $data = array())
$nodes->lxcConfig($node, $vmid)
$nodes->setLxcConfig($node, $vmid, $data = array())
$nodes->lxcFeature($node, $vmid)
$nodes->lxcInterfaces($node, $vmid)
$nodes->lxcPending($node, $vmid)
$nodes->lxcMigrateInfo($node, $vmid, $data = array())
$nodes->lxcMigrate($node, $vmid, $data = array())
$nodes->lxcMoveVolume($node, $vmid, $data = array())
$nodes->lxcMtunnelwebsocket($node, $vmid, $data = array())
$nodes->lxcMtunnel($node, $vmid, $data = array())
$nodes->lxcRemoteMigrate($node, $vmid, $data = array())
$nodes->lxcTermproxy($node, $vmid, $data = array())
$nodes->lxcFirewallRefs($node, $vmid)
$nodes->lxcResize($node, $vmid, $data = array())
$nodes->lxcRrd($node, $vmid, $ds = null, $timeframe = null)
$nodes->lxcRrddata($node, $vmid, $timeframe = null)
$nodes->lxcSpiceproxy($node, $vmid, $data = array())
$nodes->createLxcTemplate($node, $vmid, $data = array())
$nodes->createLxcVncproxy($node, $vmid, $data = array())
$nodes->lxcVncwebsocket($node, $vmid, $port = null, $vncticket = null)

Network

$nodes->Network($node, $type = null)
$nodes->createNetwork($node, $data = array())
$nodes->updateNetwork($node, $data = array())
$nodes->revertNetwork($node)
$nodes->networkIface($node, $iface)
$nodes->updateNetworkIface($node, $iface, $data = array())
$nodes->deleteNetworkIface($node, $iface)

Qemu

$nodes->Qemu($node)
$nodes->createQemu($node, $data = array())
$nodes->QemuVmid($node, $vmid)
$nodes->deleteQemu($node, $vmid, $data = array())
$nodes->qemuFirewall($node, $vmid)
$nodes->qemuFirewallAliases($node, $vmid)
$nodes->createQemuFirewallAliase($node, $vmid, $data = array())
$nodes->qemuFirewallAliasesName($node, $vmid, $name)
$nodes->updateQemuFirewallAliaseName($node, $vmid, $name, $data = array())
$nodes->deleteQemuFirewallAliaseName($node, $vmid, $name)
$nodes->qemuFirewallIpset($node, $vmid)
$nodes->createQemuFirewallIpset($node, $vmid, $data = array())
$nodes->qemuFirewallIpsetName($node, $vmid, $name)
$nodes->addQemuFirewallIpsetName($node, $vmid, $name, $data = array())
$nodes->deleteQemuFirewallIpsetName($node, $vmid, $name)
$nodes->qemuFirewallIpsetNameCidr($node, $vmid, $name, $cidr)
$nodes->updateQemuFirewallIpsetNameCidr($node, $vmid, $name, $cidr, $data = array())
$nodes->deleteQemuFirewallIpsetNameCidr($node, $vmid, $name, $cidr)
$nodes->qemuFirewallRules($node, $vmid)
$nodes->createQemuFirewallRules($node, $vmid, $data = array())
$nodes->qemuFirewallRulesPos($node, $vmid, $pos)
$nodes->updateQemuFirewallRulesPos($node, $vmid, $pos, $data = array())
$nodes->deleteQemuFirewallRulesPos($node, $vmid, $pos)
$nodes->qemuFirewallLog($node, $vmid, $limit = null, $start = null)
$nodes->qemuFirewallOptions($node, $vmid)
$nodes->setQemuFirewallOptions($node, $vmid, $data = array())
$nodes->qemuFirewallRefs($node, $vmid)
$nodes->qemuSnapshot($node, $vmid)
$nodes->createQemuSnapshot($node, $vmid, $data = array())
$nodes->qemuSnapname($node, $vmid, $snapname)
$nodes->deleteQemuSnapshot($node, $vmid, $snapname)
$nodes->qemuSnapnameConfig($node, $vmid, $snapname)
$nodes->updateQemuSnapshotConfig($node, $vmid, $snapname, $data = array())
$nodes->QemuSnapshotRollback($node, $vmid, $snapname, $data = array())
$nodes->qemuStatus($node, $vmid)
$nodes->qemuCurrent($node, $vmid)
$nodes->qemuResume($node, $vmid, $data = array())
$nodes->qemuReset($node, $vmid, $data = array())
$nodes->qemuShutdown($node, $vmid, $data = array())
$nodes->qemuStart($node, $vmid, $data = array())
$nodes->qemuStop($node, $vmid, $data = array())
$nodes->qemuReboot($node, $vmid, $data = array())
$nodes->qemuSuspend($node, $vmid, $data = array())
$nodes->qemuAgent($node, $vmid, $data = array())
$nodes->qemuAgentIndex($node, $vmid, $data = array())
$nodes->qemuAgentExec($node, $vmid, $data = array())
$nodes->qemuAgentExecStatus($node, $vmid, $data = array())
$nodes->qemuAgentFileRead($node, $vmid, $data = array())
$nodes->qemuAgentFileWrite($node, $vmid, $data = array())
$nodes->qemuAgentFsfreezeFreeze($node, $vmid, $data = array())
$nodes->qemuAgentFsfreezeStatus($node, $vmid, $data = array())
$nodes->qemuAgentFsfreezeThaw($node, $vmid, $data = array())
$nodes->qemuAgentFstrim($node, $vmid, $data = array())
$nodes->qemuAgentGetFsinfo($node, $vmid, $data = array())
$nodes->qemuAgentGetHostName($node, $vmid, $data = array())
$nodes->qemuAgentGetMemoryBlockInfo($node, $vmid, $data = array())
$nodes->qemuAgentGetMemoryBlocks($node, $vmid, $data = array())
$nodes->qemuAgentGetOsinfo($node, $vmid, $data = array())
$nodes->qemuAgentGetTime($node, $vmid, $data = array())
$nodes->qemuAgentGetTimezone($node, $vmid, $data = array())
$nodes->qemuAgentGetUsers($node, $vmid, $data = array())
$nodes->qemuAgentGetVcpus($node, $vmid, $data = array())
$nodes->qemuAgentInfo($node, $vmid, $data = array())
$nodes->qemuAgentNetworkGetInterfaces($node, $vmid, $data = array())
$nodes->qemuAgentPing($node, $vmid, $data = array())
$nodes->qemuAgentShutdown($node, $vmid, $data = array())
$nodes->qemuAgentSuspendDisk($node, $vmid, $data = array())
$nodes->qemuAgentSuspendHybrid($node, $vmid, $data = array())
$nodes->qemuAgentSuspendRam($node, $vmid, $data = array())
$nodes->qemuAgentSetUserPassword($node, $vmid, $data = array())
$nodes->qemuClone($node, $vmid, $data = array())
$nodes->qemuCloudinit($node, $vmid, $data = array())
$nodes->qemuCloudinitDump($node, $vmid, $data = array())
$nodes->setQemuCloudinit($node, $vmid, $data = array())
$nodes->qemuConfig($node, $vmid)
$nodes->createQemuConfig($node, $vmid, $data = array())
$nodes->setQemuConfig($node, $vmid, $data = array())
$nodes->qemuFeature($node, $vmid)
$nodes->qemuDbusVmstate($node, $vmid, $data = array())
$nodes->qemuMigrateInfo($node, $vmid, $data = array())
$nodes->qemuMigrate($node, $vmid, $data = array())
$nodes->qemuMonitor($node, $vmid, $data = array())
$nodes->qemuMoveDisk($node, $vmid, $data = array())
$nodes->qemuMtunnelwebsocket($node, $vmid, $data = array())
$nodes->qemuMtunnel($node, $vmid, $data = array())
$nodes->qemuRemoteMigrate($node, $vmid, $data = array())
$nodes->qemuPending($node, $vmid)
$nodes->qemuResize($node, $vmid, $data = array())
$nodes->qemuRrd($node, $vmid, $ds = null, $timeframe = null)
$nodes->qemuRrddata($node, $vmid, $timeframe = null)
$nodes->qemuSendkey($node, $vmid, $data = array())
$nodes->qemuSpiceproxy($node, $vmid, $data = array())
$nodes->qemuTermproxy($node, $vmid, $data = array())
$nodes->createQemuTemplate($node, $vmid, $data = array())
$nodes->qemuUnlink($node, $vmid, $data = array())
$nodes->createQemuVncproxy($node, $vmid, $data = array())
$nodes->qemuVncwebsocket($node, $vmid, $port = null, $vncticket = null)

Nodes Replication

$nodes->Replication($node)
$nodes->replicationId($node, $id)
$nodes->replicationLog($node, $id)
$nodes->replicationScheduleNow($node, $id, $data = array())
$nodes->replicationStatus($node, $id)

Scan

$nodes->Scan($node)
$nodes->scanGlusterfs($node)
$nodes->scanNfs($node, $data = array())
$nodes->scanCifs($node, $data = array())
$nodes->scanPbs($node, $data = array())
$nodes->scanIscsi($node, $data = array())
$nodes->scanLvm($node, $data = array())
$nodes->scanLvmthin($node, $data = array())
$nodes->scanUsb($node, $data = array())
$nodes->scanZfs($node, $data = array())

SDN

$nodes->sdn($node, $data = array())
$nodes->sdnFabricsFabric($node, $fabric, $data = array())
$nodes->sdnFabricsFabricInterfaces($node, $fabric, $data = array())
$nodes->sdnFabricsFabricNeighbors($node, $fabric, $data = array())
$nodes->sdnFabricsFabricRoutes($node, $fabric, $data = array())
$nodes->sdnVnetsVnet($node, $vnet, $data = array())
$nodes->sdnVnetsVnetMacVrf($node, $vnet, $data = array())
$nodes->sdnZones($node, $data = array())
$nodes->sdnZonesZone($node, $zone, $data = array())
$nodes->sdnZonesZoneBridges($node, $zone, $data = array())
$nodes->sdnZonesZoneContent($node, $zone, $data = array())
$nodes->sdnZonesZoneIpVrf($node, $zone, $data = array())

Hardware

$nodes->hardware($node, $data = array())
$nodes->hardwarePci($node, $data = array())
$nodes->hardwarePciPciid($node, $pciid, $data = array())
$nodes->hardwarePciPciidMdev($node, $pciid, $data = array())

Metadata Queries

$nodes->queryUrlMetadata($node, $data = array())
$nodes->queryOciRepoTags($node, $data = array())

Service

$nodes->Services($node)
$nodes->listService($node, $service)
$nodes->servicesReload($node, $service, $data = array())
$nodes->servicesRestart($node, $service, $data = array())
$nodes->servicesStart($node, $service, $data = array())
$nodes->servicesStop($node, $service, $data = array())
$nodes->servicesState($node, $service)

Nodes Storage

$nodes->Storage($node, $content = null, $storage = null, $target = null, $enabled = null)
$nodes->getStorage($node, $storage)
$nodes->listStorageContent($node, $storage)
$nodes->storageImportMetadata($node, $storage, $data = array())
$nodes->storageDownloadUrl($node, $storage, $data = array())
$nodes->storageOciRegistryPull($node, $storage, $data = array())
$nodes->storagePrunebackups($node, $storage, $data = array())
$nodes->deleteStoragePrunebackups($node, $storage, $data = array())
$nodes->storageFileRestoreList($node, $storage, $data = array())
$nodes->storageFileRestoreDownload($node, $storage, $data = array())
$nodes->storageContent($node, $storage, $data = array())
$nodes->storageContentVolume($node, $storage, $volume)
$nodes->setStorageContentVolume($node, $storage, $volume, $data = array())
$nodes->copyStorageContentVolume($node, $storage, $volume, $data = array())
$nodes->deleteStorageContentVolume($node, $storage, $volume)
$nodes->storageRRD($node, $storage = null, $ds = null, $timeframe = null, $cf = null)
$nodes->storageRRDdata($node, $storage = null, $timeframe = null, $cf = null)
$nodes->storageStatus($node, $storage = null)
$nodes->storageUpload($node, $storage = null, $data = array())

Tasks

$nodes->Tasks($node, $errors = null, $limit = null, $vmid = null, $start = null)
$nodes->tasksUpid($node, $upid)
$nodes->tasksStop($node, $upid)
$nodes->tasksLog($node, $upid, $limit = null, $start = null)
$nodes->tasksStatus($node, $upid)

Vzdump

$nodes->createVzdump($node, $data = array())
$nodes->vzdumpDefaults($node)
$nodes->VzdumpExtractConfig($node)