Libvirt bindings for Node.js®
npm install @avaflow/libvirt![Cover image][cover]
![Alpha badge][alphabadge]
![CI badge][cibadge]
![License badge][licensebadge]
![Contributors badge][contribadge]
![Issues badge][issuesbadge]
![PR badge][prbadge]
Libvirt bindings for Node.js®.
``typescript
import libvirt, {
DomainBuilder,
domainDescToXml,
domainDescFromXml,
} from "@vmngr/libvirt";
const uri = process.env.LIBVIRT_URI || "qemu:///system";
const hypervisor = new libvirt.Hypervisor({ uri });
(async () => {
await hypervisor.connectOpen();
// parse xml template
const template = await domainDescFromXml("
// build new domain description
const domain = new DomainBuilder()
.fromTemplate(template)
.setName("test1")
.setUUID("148d0864-2354-4c27-b82c-731bdd3f320c")
.addDisk({
type: "file", device: "disk",
driver: { name: "qemu", type: "qcow2" },
source: { file: "/home/leon/test1.img" },
target: { dev: "vda", bus: "virtio" },
})
.addInterface({
type: "network",
source: { network: "default" },
mac: { address: "52:54:00:8e:c6:5f" },
model: { type: "virtio" },
})
.build();
// define and boot domain
const xml = domainDescToXml(domain);
await hypervisor.domainCreateXML(xml);
// list active domains
const activeDomains = await hypervisor.connectListAllDomains(
libvirt.ConnectListAllDomainsFlags.ACTIVE);
// log active domain names
const activeDomainNames = await Promise.all(activeDomains
.map((domain) => hypervisor.domainGetName(domain)));
console.log(activeDomainNames);
await hypervisor.connectClose();
})();
`
bash
$ sudo apt install build-essential libvirt-dev
$ npm i @vmngr/libvirt
`$3
Install Homebrew and Xcode first if not already installed.
bash
$ brew install libvirt
$ npm i @vmngr/libvirt
`Contribute
Any contribution is welcome! To check wether your contribution conforms our style guide run the following tasks:
bash
$ pip install cppcheck # required once
$ git submodule update --init --recursive # required once$ npm run lint/bindings
$ npm run lint/lib
$ npm run lint/examples
``---
MIT License
Copyright (c) 2019 Leon Rinkel
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[cover]: cover.png "Cover image"
[alphabadge]: https://img.shields.io/badge/-alpha-green "Alpha badge"
[licensebadge]: https://img.shields.io/github/license/vmngr/libvirt "License badge"
[cibadge]: https://github.com/vmngr/libvirt/workflows/CI/badge.svg "CI badge"
[contribadge]: https://img.shields.io/github/contributors/vmngr/libvirt "Contributors badge"
[issuesbadge]: https://img.shields.io/github/issues/vmngr/libvirt "Issues badge"
[prbadge]: https://img.shields.io/github/issues-pr/vmngr/libvirt "PR badge"