Socket
Socket
Sign inDemoInstall

lxc-query

Package Overview
Dependencies
0
Maintainers
1
Versions
30
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

lxc-query

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


Version published
Maintainers
1
Weekly downloads
3
increased by50%

Weekly downloads

Readme

Source

LXC Query

JavaScript Style Guide NPM Build Status Known Vulnerabilities

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.

Parameters & Call

ParameterTypeDescriptionDefault
remotestringLXD remote and endpointlocal
rest methodstringe.g GET, POST, DELETE, PUT, PATCHGET
payloadobject | json stringRest json payload
mutatorfunctionPre-resolve mutation function
const lxc = require('lxc-query')

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

Express example

Using express you can map the rest calls to the lib as shown below:

const lxc = require('lxc-query')
const express = require('express')
const app = express()

app.all('/*', (req, res) => {
    lxc.query(req.url.substr(1), req.method, req.body).then(response => res.json(response))
})

app.listen(3000)

So using the above if you visited http://127.0.0.1:3000/local:/1.0/containers it would proxy it though to local LXD server, list containers.. You could do this for any rest method or LXD endpoint, with the addition that local: can be any of your defined remotes!

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.

Keywords

FAQs

Last updated on 14 Apr 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc