Skip to content
一个用于管理 Libvirt KVM 虚拟机的 PHP 工具类,只需几行代码就能轻松创建、修改、控制虚拟机。
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


中文 ReadMe | ZeroDream

This is a simple php libvirt manager

It can start, shutdown, destory, get the virtual machines list or get the information for any virtual machine.

This project is to make it easier for developers to manage virtual machines.

You need install php_ssh2 module to use this manager.

Maybe this document has some grammatical mistakes, because the author is Chinese :P

Install Libvirt-Manager

Use composer

composer require kasuganosoras/libvirt-manager

Use git

git clone

Example code for connect a server

This example code will connect to your server using SSH, make sure your server sshd service is running.

require_once __DIR__ . '/vendor/autoload.php';
use libvirt_manager\Libvirt;
$Libvirt = new Libvirt();
$Libvirt->setHost("", 22, "/data/libvirt/");
$Libvirt->connect("root", "123456");

The is your server hostname, 22 is your server port, and /data/libvirt/ is your libvirt data save path.

For authenticate, use username and password, the username and password in example code is root and 123456.

Example code for create a virtual machine

The following example code will create a virtual machine called Test and allocate 2 CPU cores, 2 GB of memory to it.

$Libvirt->createDisk("Test", "qcow2", "30G");
$Libvirt->createVMXML("Test", 2, 2048576, "/data/libvirt/images/Test/Test.qcow2", "/data/iso/CentOS-7-x86_64-Minimal-1804.iso", "cdrom", "network", "default", $Libvirt->randomMac(), "virbr0", 0, 0, 5902);

Create a virtual disk

String createDisk ( Name, Format, Size )

create a Virtual Machine xml config file

The method of createVMXML have 13 params.

void createVMXL ( Name, vCPU, Ram, Disk, ISO, Boot Device, Network type, Network name, MAC Address, Network bridge, Bandwidth in, Bandwidth out, VNC Port )

Register the xml config file to system

String define ( XML File Path )

Set execute permission

void setPermission ( Name )

Start the virtual machine

String start ( Name )

Stop the virtual machine

String shutdown ( Name )

Force stop the virtual machine

if your virtual machine is in trouble and can't use shutdown to make if off, you can use this method to force stop it.

String destroy ( Name )

Get the virtual machine list

You can use this method to get the virtual machine list, It will return an array.

String getList ()

Get the virtual machine information

You can use this method to get any registed virtual machine information, It will return an array.

String getInfo ( Name )

Dump the virtual machine xml config file

This method can get any registered virtual machine xml config file and return.

String dumpxml ( Name )

Clone an exist virtual machine

You can use this method to clone a exist virtual machine.

This method may take a long time, you need add a line set_time_limit(120) in your code.

String cloneVM ( Name, New name, New disk path )

Set the virtual machine network

This method can control the virtual machine network.

The third param is Boolean type, if you give it a true value, the network will enable, else the network will disable.

String setNetwork ( Server, Network name, Status )

You can find out more info in libvirt/libvirt.php

You can’t perform that action at this time.