.TH "GCLOUD_ALPHA_BMS_INSTANCES_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha bms instances update \- update a Bare Metal Solution instance



.SH "SYNOPSIS"
.HP
\f5gcloud alpha bms instances update\fR (\fIINSTANCE\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-async\fR] [\fB\-\-[no\-]enable\-hyperthreading\fR] [\fB\-\-kms\-crypto\-key\-version\fR=\fIKMS_CRYPTO_KEY_VERSION\fR] [\fB\-\-os\-image\fR=\fIOS_IMAGE\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fB\-\-clear\-ssh\-keys\fR\ |\ \fB\-\-ssh\-keys\fR=[\fISSH_KEYS\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR 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 \f5describe\fR
command for the instance.



.SH "EXAMPLES"

To update an instance called \f5\fImy\-instance\fR\fR in region
\f5\fIus\-central1\fR\fR with a new label \f5\fIkey1=value1\fR\fR, run:

.RS 2m
$ gcloud alpha bms instances update my\-instance \e
    \-\-region=us\-central1 \-\-update\-labels=key1=value1
.RE

To clear all labels, run:

.RS 2m
$ gcloud alpha bms instances update my\-instance \e
    \-\-region=us\-central1 \-\-clear\-labels
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5instance\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIINSTANCE\fR

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

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Region of the resource.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-[no\-]enable\-hyperthreading\fR

Enable hyperthreading for the server. Use \fB\-\-enable\-hyperthreading\fR to
enable and \fB\-\-no\-enable\-hyperthreading\fR to disable.

.TP 2m
\fB\-\-kms\-crypto\-key\-version\fR=\fIKMS_CRYPTO_KEY_VERSION\fR

Resource ID of a KMS CryptoKeyVersion used to encrypt the initial password.

https://cloud.google.com/kms/docs/resource\-hierarchy#key_versions

.TP 2m
\fB\-\-os\-image\fR=\fIOS_IMAGE\fR

OS image to install on the server.

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

.RS 2m
$ gcloud bms os\-images list
.RE

.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

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 (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud alpha bms instances update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud alpha bms instances update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-ssh\-keys\fR

Provisions the instance without any SSH keys.

.TP 2m

SSH key resource \- ssh_key. This represents a Cloud resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-ssh\-keys\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-ssh\-keys\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
global is the only supported location.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-ssh\-keys\fR=[\fISSH_KEYS\fR,...]

IDs of the SSH keys or fully qualified identifiers for the SSH keys.

To set the \f5ssh_key\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-ssh\-keys\fR on the command line.
.RE
.sp


.RE
.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. This variant is also available:

.RS 2m
$ gcloud bms instances update
.RE