Skip to content

Home

JavaScript Style Guide NPM Build Status

A Node.js LXD client which uses your local instance of LXD and lxc query to manage your local or remote LXD servers.

You must be using >= LXD 2.17

Install

Require this package with npm using the following command:

$ npm i lxc-query

Usage

Essentially you can do any LXD operation with the single lxc.query method, or you can use the helper methods which cover all the LXD endpoints (see side menu).

Parameters & Call

Parameter Type Description Default
remote string LXD remote and endpoint local
rest method string e.g GET, POST, DELETE, PUT, PATCH GET
payload object | json string Rest json payload
mutator function Pre-resolve mutation function
const lxc = require('lxc-query')

lxc.query('remote:/1.0', 'GET', {}).then(response => {
    console.log(response)
})

Check out the LXD RESTapi, for more information.

Contributing

Please see CONTRIBUTING for details.

Developer Support / Sponsor

If you want to show your appreciation, please feel free to make a donation https://www.paypal.me/lcherone, thanks.

Credits

License

The MIT License (MIT). Please see License File for more information.

Check out LXD-UI - A simple easy to use GUI for your local LXD server.