NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
8c5ee4eafe49cdcd0460b33e6543aa46df85d762
xen-orchestra/@vates/nbd-client
History
Pierre Donias 8c5ee4eafe feat: technical release (#6921) 
* feat(@xen-orchestra/fs): 4.0.1

* feat(xen-api): 1.3.3

* feat(@vates/nbd-client): 1.2.1

* feat(@vates/node-vsphere-soap): 1.0.0

* feat(@vates/task): 0.2.0

* feat(@xen-orchestra/backups): 0.39.0

* feat(@xen-orchestra/backups-cli): 1.0.9

* feat(@xen-orchestra/mixins): 0.10.2

* feat(@xen-orchestra/proxy): 0.26.29

* feat(@xen-orchestra/vmware-explorer): 0.2.3

* feat(xo-cli): 0.20.0

* feat(xo-server): 5.117.0

* feat(xo-server-auth-oidc): 0.3.0

* feat(xo-server-perf-alert): 0.3.6

* feat(xo-web): 5.120.0

* chore(CHANGELOG): update next
2023-06-28 17:10:22 +02:00
..
tests
test(nbd-client): test secure connection
2023-06-07 10:24:14 +02:00
.npmignore
feat(nbd-client): first implementation (#6444)
2022-10-12 14:46:16 +02:00
.USAGE.md
feat(nbd-client): first implementation (#6444)
2022-10-12 14:46:16 +02:00
constants.js
feat(nbd-client): first implementation (#6444)
2022-10-12 14:46:16 +02:00
index.js
fix(nbd-client/readBlocks): BigInt handling for default generator
2023-06-07 10:24:14 +02:00
package.json
feat: technical release (#6921)
2023-06-28 17:10:22 +02:00
README.md
docs: uniformize code blocks
2023-02-06 11:25:12 +01:00

README.md

@vates/nbd-client

Package Version License PackagePhobia Node compatibility

Install

Installation of the npm package:

npm install --save @vates/nbd-client

Usage

new NdbClient({address, exportname, secure = true, port = 10809})

create a new nbd client

import NbdClient from '@vates/nbd-client'
const client = new NbdClient({
  address: 'MY_NBD_HOST',
  exportname: 'MY_SECRET_EXPORT',
  cert: 'Server certificate', // optional, will use encrypted link if provided
})

await client.connect()
const block = await client.readBlock(blockIndex, BlockSize)
await client.disconnect()

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

  • report any issue you've encountered;
  • fork and create a pull request.

License

ISC © Vates SAS