# simple-libvirt

> A simple libvirt NodeJS wrapper

Latest version **0.0.1** (published 2017-05-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-libvirt
pnpm add simple-libvirt
yarn add simple-libvirt
bun add simple-libvirt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-05-05 |
| First published | 2017-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Adrien Vasseur |
| Maintainers | lanquemar |
| Keywords | libvirt, simple, virt |

## Links

- npm: https://www.npmjs.com/package/simple-libvirt
- Repository: https://github.com/lanquemar/simple-libvirt
- Homepage: https://github.com/lanquemar/simple-libvirt#readme
- Issues: https://github.com/lanquemar/simple-libvirt/issues
- npm.io page: https://npm.io/package/simple-libvirt

## Dependencies (2)

- [nan](https://npm.io/package/nan.md) ^2.6.2
- [bindings](https://npm.io/package/bindings.md) ^1.2.1

## Recent versions

- 0.0.1 (latest) — 2017-05-05

## README

# Simple-libvirt
This package is a simple [Libvirt][libvirt_home] [NodeJS][nodejs_home] wrapper.

## Installation
### Dependencies

 * Libvirt
 * NodeJS v0.12.x or higher
 
### Package installation
```Shell
$ npm install --save simple-libvirt
```

### Example of use

```JavaScript
var simple_libvirt = require('simple-libvirt');

var hyperv = simple_libvirt.Hypervisor();
hyperv.connect('test:///default', function(err) {
    if (err)
        console.log('Error: ' + err);
    else
        console.log('Connection succeeded!');
});
```

## API status
Work in progress...

| Command          | Method    | Status |
| :---             | :---      | :---:  |
| Connect to the virt-manager server | `connect` | ✓ |
| Disconnect the current connection | `disconnect` | ✓ |
| Start a domain by his name | `startByName` | ✓ |
| Shutdown a domain by his name | `shutdownByName` | ✓ |
| Delete a domain by his name | `deleteByName` | ✓ |
| Get all domains infos | `getAllDomains` | ✓ |
| Get domain info by his name | `getDomainByName` | ✓ |

## References

The wrappered API propose the very simple libvirt calls, please see:

 * API Reference: http://libvirt.org/html/libvirt-libvirt.html
 * Development Guide: http://libvirt.org/devguide.html

[nodejs_home]: http://www.nodejs.org
[libvirt_home]: http://www.libvirt.org

---
_Source: https://npm.io/package/simple-libvirt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._