Bare Metal Solution API: Node.js Client

release level npm version

baremetalsolution client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Bare Metal Solution API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/bare-metal-solution

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Bare_metal_solution.create_nfs_sharesource codeOpen in Cloud Shell
Bare_metal_solution.create_provisioning_configsource codeOpen in Cloud Shell
Bare_metal_solution.create_s_s_h_keysource codeOpen in Cloud Shell
Bare_metal_solution.create_volume_snapshotsource codeOpen in Cloud Shell
Bare_metal_solution.delete_nfs_sharesource codeOpen in Cloud Shell
Bare_metal_solution.delete_s_s_h_keysource codeOpen in Cloud Shell
Bare_metal_solution.delete_volume_snapshotsource codeOpen in Cloud Shell
Bare_metal_solution.detach_lunsource codeOpen in Cloud Shell
Bare_metal_solution.disable_interactive_serial_consolesource codeOpen in Cloud Shell
Bare_metal_solution.enable_interactive_serial_consolesource codeOpen in Cloud Shell
Bare_metal_solution.evict_lunsource codeOpen in Cloud Shell
Bare_metal_solution.evict_volumesource codeOpen in Cloud Shell
Bare_metal_solution.get_instancesource codeOpen in Cloud Shell
Bare_metal_solution.get_lunsource codeOpen in Cloud Shell
Bare_metal_solution.get_networksource codeOpen in Cloud Shell
Bare_metal_solution.get_nfs_sharesource codeOpen in Cloud Shell
Bare_metal_solution.get_provisioning_configsource codeOpen in Cloud Shell
Bare_metal_solution.get_volumesource codeOpen in Cloud Shell
Bare_metal_solution.get_volume_snapshotsource codeOpen in Cloud Shell
Bare_metal_solution.list_instancessource codeOpen in Cloud Shell
Bare_metal_solution.list_lunssource codeOpen in Cloud Shell
Bare_metal_solution.list_network_usagesource codeOpen in Cloud Shell
Bare_metal_solution.list_networkssource codeOpen in Cloud Shell
Bare_metal_solution.list_nfs_sharessource codeOpen in Cloud Shell
Bare_metal_solution.list_o_s_imagessource codeOpen in Cloud Shell
Bare_metal_solution.list_provisioning_quotassource codeOpen in Cloud Shell
Bare_metal_solution.list_s_s_h_keyssource codeOpen in Cloud Shell
Bare_metal_solution.list_volume_snapshotssource codeOpen in Cloud Shell
Bare_metal_solution.list_volumessource codeOpen in Cloud Shell
Bare_metal_solution.rename_instancesource codeOpen in Cloud Shell
Bare_metal_solution.rename_networksource codeOpen in Cloud Shell
Bare_metal_solution.rename_nfs_sharesource codeOpen in Cloud Shell
Bare_metal_solution.rename_volumesource codeOpen in Cloud Shell
Bare_metal_solution.reset_instancesource codeOpen in Cloud Shell
Bare_metal_solution.resize_volumesource codeOpen in Cloud Shell
Bare_metal_solution.restore_volume_snapshotsource codeOpen in Cloud Shell
Bare_metal_solution.start_instancesource codeOpen in Cloud Shell
Bare_metal_solution.stop_instancesource codeOpen in Cloud Shell
Bare_metal_solution.submit_provisioning_configsource codeOpen in Cloud Shell
Bare_metal_solution.update_instancesource codeOpen in Cloud Shell
Bare_metal_solution.update_networksource codeOpen in Cloud Shell
Bare_metal_solution.update_nfs_sharesource codeOpen in Cloud Shell
Bare_metal_solution.update_provisioning_configsource codeOpen in Cloud Shell
Bare_metal_solution.update_volumesource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Bare Metal Solution API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/bare-metal-solution@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE