NAME

gcloud alpha compute instances add-labels - add labels to Google Compute Engine virtual machine instances

SYNOPSIS

gcloud alpha compute instances add-labels INSTANCE_NAME --labels=[KEY=VALUE,...] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) gcloud alpha compute instances add-labels adds labels to a Google Compute Engine virtual machine instance.

EXAMPLES

To add key-value pairs k0=v0 and k1=v1 to 'example-instance'

$ gcloud alpha compute instances add-labels example-instance \ --labels=k0=v0,k1=v1

Labels can be used to identify the instance and to filter them. To find a instance labeled with key-value pair k1, v2

$ gcloud alpha compute instances list --filter='labels.k1:v2'

To list only the labels when describing a resource, use --format

$ gcloud alpha compute instances describe example-instance \ --format='default(labels)'

POSITIONAL ARGUMENTS

INSTANCE_NAME

Name of the instance to operate on. For details on valid instance names, refer to the criteria documented under the field 'name' at: https://cloud.google.com/compute/docs/reference/rest/v1/instances

REQUIRED FLAGS

--labels=[KEY=VALUE,...]

A list of labels to add.

OPTIONAL FLAGS

--zone=ZONE

Zone of the instance to operate on. If not specified, you might be prompted to select a zone (interactive mode only). gcloud attempts to identify the appropriate zone by searching for resources in your currently active project. If the zone cannot be determined, gcloud prompts you for a selection with all available Google Cloud Platform zones.

To avoid prompting when this flag is omitted, the user can set the compute/zone property:

$ gcloud config set compute/zone ZONE

A list of zones can be fetched by running:

$ gcloud compute zones list

To unset the property, run:

$ gcloud config unset compute/zone

Alternatively, the zone can be stored in the environment variable CLOUDSDK_COMPUTE_ZONE.

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. These variants are also available:

$ gcloud compute instances add-labels

$ gcloud beta compute instances add-labels