# proxmox-lib

> Proxmox Simple Library

Latest version **1.0.17** (published 2016-09-27) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install proxmox-lib
pnpm add proxmox-lib
yarn add proxmox-lib
bun add proxmox-lib
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.17 |
| Published | 2016-09-27 |
| First published | 2016-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jairo Caro-Accino Viciana |
| Maintainers | kidandcat |

## Links

- npm: https://www.npmjs.com/package/proxmox-lib
- Repository: https://github.com/kidandcat/node-proxmox-lib
- Homepage: https://github.com/kidandcat/node-proxmox-lib#readme
- Issues: https://github.com/kidandcat/node-proxmox-lib/issues
- npm.io page: https://npm.io/package/proxmox-lib

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.73.0

## Recent versions

- 1.0.17 (latest) — 2016-09-27
- 1.0.16 — 2016-09-06
- 1.0.15 — 2016-08-25
- 1.0.14 — 2016-08-22
- 1.0.13 — 2016-08-22
- 1.0.12 — 2016-08-04
- 1.0.11 — 2016-08-03
- 1.0.9 — 2016-07-27
- 1.0.8 — 2016-07-27
- 1.0.7 — 2016-07-25
- 1.0.6 — 2016-07-25
- 1.0.5 — 2016-07-25
- 1.0.4 — 2016-07-22
- 1.0.3 — 2016-07-22
- 1.0.2 — 2016-07-22
- … 2 more at https://npm.io/package/proxmox-lib/versions

## README

# Proxmox Simple Library

## Status

- In progress

## Requirements

- Proxmox VE Api Version 2 -> <https://pve.proxmox.com/wiki/Proxmox_VE_API>

## Install

```
npm install proxmox-lib
```

## Use

```
  var px = require('proxmox-lib')({
    url: 'https://localhost:8006',
    user: 'root',
    password: 'password',
    node: ['node1', 'node2'],
    templateStorage: 'local',
    vncserver: 'https://localhost:8006'
  });
```

## Functions

- px.status(callback) -> Cluster status

- px.nextId(callback) -> Next free VM ID

- px.nodeStatus(callback) -> Node status

- px.listTemplates(callback) -> List container available templates

- px.deleteContainer(id, callback) -> Delete the container

- px.statusContainer(id, callback) -> Status of container

- px.vncContainer(id, callback) -> Url for vnc terminal

- px.startContainer(id, callback) -> Start container

- px.stopContainer(id, callback) -> Stop container

- px.createContainer(options, callback) -> Create container

  - template: 'string',
  - cpu: 'number',
  - hostname: 'string',
  - memory: 'number|megabytes',
  - ostype: 'string|ubuntu,debian,centos,archlinux',
  - storage: 'string',
  - swap: 'number|megabytes',
  - disk: 'number|gigabytes',
  - password: 'string'

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