- NAME
-
- gcloud bms instances update - update a Bare Metal Solution instance
- SYNOPSIS
-
-
gcloud bms instances update(INSTANCE:--region=REGION) [--async] [--[no-]enable-hyperthreading] [--os-image=OS_IMAGE] [--update-labels=[KEY=VALUE,…]] [--clear-labels|--remove-labels=[KEY,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
Update a Bare Metal Solution instance.
This call returns immediately, but the update operation may take several minutes to complete. To check if the operation is complete, use the
describecommand for the instance. - EXAMPLES
-
To update an instance called
in regionmy-instancewith a new labelus-central1, run:key1=value1gcloud bms instances update my-instance --region=us-central1 --update-labels=key1=value1To clear all labels, run:
gcloud bms instances update my-instance --region=us-central1 --clear-labels - POSITIONAL ARGUMENTS
-
-
Instance resource - instance. The arguments in this group can be used to specify
the attributes of this resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
instanceon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
INSTANCE-
ID of the instance or fully qualified identifier for the instance.
To set the
instanceattribute:-
provide the argument
instanceon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--region=REGION-
Region of the resource.
To set the
regionattribute:-
provide the argument
instanceon the command line with a fully specified name; -
provide the argument
--regionon the command line.
-
provide the argument
-
provide the argument
-
Instance resource - instance. The arguments in this group can be used to specify
the attributes of this resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.
- FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--[no-]enable-hyperthreading-
Enable hyperthreading for the server. Use
--enable-hyperthreadingto enable and--no-enable-hyperthreadingto disable. --os-image=OS_IMAGE-
OS image to install on the server.
To list all OS image codes supported by BMS, run:
gcloud bms os-images list --update-labels=[KEY=VALUE,…]-
List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens (
-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers. -
At most one of these can be specified:
--clear-labels-
Remove all labels. If
--update-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloud bms instances update --clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloud bms instances update --clear-labels --update-labels foo=bar,baz=qux --remove-labels=[KEY,…]-
List of label keys to remove. If a label does not exist it is silently ignored.
If
--update-labelsis also specified then--update-labelsis applied first.
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - NOTES
-
This variant is also available:
gcloud alpha bms instances update
gcloud bms instances update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-29 UTC.