Bare Metal Solution API: Node.js Client

release levelnpm version

baremetalsolution client for Node.js

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

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient 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 theAPI from your local workstation.

Installing the client library

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

Samples

Samples are in thesamples/ directory. Each sample'sREADME.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

TheBare Metal Solution API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/bare-metal-solution@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to be inpreview. This means it is still awork-in-progress and under active development. Any release is subject tobackwards-incompatible changes at any time.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.