Skip to content

Latest commit

 

History

History

README.md

Google Cloud Platform logo

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority

npm version

Bare Metal Solution API 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 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.

Sample Source Code
create nfs share source code
create provisioning config source code
create s s h key source code
create volume snapshot source code
delete nfs share source code
delete s s h key source code
delete volume snapshot source code
detach lun source code
disable interactive serial console source code
enable interactive serial console source code
evict lun source code
evict volume source code
get instance source code
get lun source code
get network source code
get nfs share source code
get provisioning config source code
get volume source code
get volume snapshot source code
list instances source code
list luns source code
list network usage source code
list networks source code
list nfs shares source code
list o s images source code
list provisioning quotas source code
list s s h keys source code
list volume snapshots source code
list volumes source code
rename instance source code
rename network source code
rename nfs share source code
rename volume source code
reset instance source code
resize volume source code
restore volume snapshot source code
start instance source code
stop instance source code
submit provisioning config source code
update instance source code
update network source code
update nfs share source code
update provisioning config source code
update volume source code
cloud source code

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE