gcloud alpha bms instances update

NAME
gcloud alpha bms instances update - update a Bare Metal Solution instance
SYNOPSIS
gcloud alpha bms instances update (INSTANCE : --region=REGION) [--async] [--[no-]enable-hyperthreading] [--kms-crypto-key-version=KMS_CRYPTO_KEY_VERSION] [--os-image=OS_IMAGE] [--update-labels=[KEY=VALUE,…]] [--clear-labels     | --remove-labels=[KEY,…]] [--clear-ssh-keys     | --ssh-keys=[SSH_KEYS,…]] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) 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 describe command for the instance.

EXAMPLES
To update an instance called my-instance in region us-central1 with a new label key1=value1, run: 
gcloud alpha bms instances update my-instance --region=us-central1 --update-labels=key1=value1

To clear all labels, run: 

gcloud alpha 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 project attribute:

  • provide the argument instance on the command line with a fully specified name;
  • provide the argument --project on 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 instance attribute:

  • provide the argument instance on the command line.

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

--region=REGION
Region of the resource.

To set the region attribute:

  • provide the argument instance on the command line with a fully specified 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-hyperthreading to enable and --no-enable-hyperthreading to disable.
--kms-crypto-key-version=KMS_CRYPTO_KEY_VERSION
Resource ID of a KMS CryptoKeyVersion used to encrypt the initial password.

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

--os-image=OS_IMAGE
OS image to install on the server.
--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-labels is also specified then --clear-labels is applied first.

For example, to remove all labels: 

gcloud alpha bms instances update --clear-labels

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

gcloud alpha 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-labels is also specified then --update-labels is applied first.
At most one of these can be specified:
--clear-ssh-keys
Provisions the instance without any SSH keys.
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 project attribute:

  • provide the argument --ssh-keys on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

To set the region attribute:

  • provide the argument --ssh-keys on the command line with a fully specified name;
  • global is the only supported location.
--ssh-keys=[SSH_KEYS,…]
IDs of the SSH keys or fully qualified identifiers for the SSH keys.

To set the ssh_key attribute:

  • provide the argument --ssh-keys on the command line.
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 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: 
gcloud bms instances update