File: //snap/google-cloud-cli/394/help/man/man1/gcloud_compute_instances_add-labels.1
.TH "GCLOUD_COMPUTE_INSTANCES_ADD\-LABELS" 1
.SH "NAME"
.HP
gcloud compute instances add\-labels \- add labels to Google Compute Engine virtual machine instances
.SH "SYNOPSIS"
.HP
\f5gcloud compute instances add\-labels\fR \fIINSTANCE_NAME\fR \fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...] [\fB\-\-zone\fR=\fIZONE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fBgcloud compute instances add\-labels\fR adds labels to a Google Compute
Engine virtual machine instance.
.SH "EXAMPLES"
To add key\-value pairs \f5\fIk0\fR\fR=\f5\fIv0\fR\fR and
\f5\fIk1\fR\fR=\f5\fIv1\fR\fR to 'example\-instance'
.RS 2m
$ gcloud compute instances add\-labels example\-instance \e
\-\-labels=k0=v0,k1=v1
.RE
Labels can be used to identify the instance and to filter them. To find a
instance labeled with key\-value pair \f5\fIk1\fR\fR, \f5\fIv2\fR\fR
.RS 2m
$ gcloud compute instances list \-\-filter='labels.k1:v2'
.RE
To list only the labels when describing a resource, use \-\-format
.RS 2m
$ gcloud compute instances describe example\-instance \e
\-\-format='default(labels)'
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
\fIINSTANCE_NAME\fR
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
.RE
.sp
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
A list of labels to add.
.RE
.sp
.SH "OPTIONAL FLAGS"
.RS 2m
.TP 2m
\fB\-\-zone\fR=\fIZONE\fR
Zone of the instance to operate on. If not specified, you might be prompted to
select a zone (interactive mode only). \f5gcloud\fR attempts to identify the
appropriate zone by searching for resources in your currently active project. If
the zone cannot be determined, \f5gcloud\fR 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
\f5\fIcompute/zone\fR\fR property:
.RS 2m
$ gcloud config set compute/zone ZONE
.RE
A list of zones can be fetched by running:
.RS 2m
$ gcloud compute zones list
.RE
To unset the property, run:
.RS 2m
$ gcloud config unset compute/zone
.RE
Alternatively, the zone can be stored in the environment variable
\f5\fICLOUDSDK_COMPUTE_ZONE\fR\fR.
.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"
These variants are also available:
.RS 2m
$ gcloud alpha compute instances add\-labels
.RE
.RS 2m
$ gcloud beta compute instances add\-labels
.RE