1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00
gcloud-help/gcloud/alpha/bms/instances/update
2022-03-16 08:47:18 +00:00

99 lines
3.7 KiB
Text

NAME
gcloud alpha bms instances update - update a Bare Metal Solution instance
SYNOPSIS
gcloud alpha bms instances update (INSTANCE : --region=REGION)
[--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
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 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
--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.
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