gcloud bms instances update

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 minutesto complete. To check if the operation is complete, use thedescribe command for the instance.

EXAMPLES
To update an instance calledmy-instance inregionus-central1 with a new labelkey1=value1, run:
gcloudbmsinstancesupdatemy-instance--region=us-central1--update-labels=key1=value1

To clear all labels, run:

gcloudbmsinstancesupdatemy-instance--region=us-central1--clear-labels
POSITIONAL ARGUMENTS
Instance resource - instance. The arguments in this group can be used to specifythe attributes of this resource. (NOTE) Some attributes are not given argumentsin this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentinstance on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

INSTANCE
ID of the instance or fully qualified identifier for the instance.

To set theinstance attribute:

  • provide the argumentinstance on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--region=REGION
Region of the resource.

To set theregion attribute:

  • provide the argumentinstance on the command line with a fullyspecified name;
  • provide the argument--region on the command line.
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-hyperthreading to disable.
--os-image=OS_IMAGE
OS image to install on the server.

To list all OS image codes supported by BMS, run:

gcloudbmsos-imageslist
--update-labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to update. If a label exists, its value ismodified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. 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-labels is also specified then--clear-labels is applied first.

For example, to remove all labels:

gcloudbmsinstancesupdate--clear-labels

To remove all existing labels and create two new labels,foo andbaz:

gcloudbmsinstancesupdate--clear-labels--update-labelsfoo=bar,baz=qux
--remove-labels=[KEY,…]
List of label keys to remove. If a label does not exist it is silently ignored.If--update-labels is also specified then--update-labels is 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 help for details.

NOTES
This variant is also available:
gcloudalphabmsinstancesupdate

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-07-29 UTC.