File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_compute_images_update.1
.TH "GCLOUD_ALPHA_COMPUTE_IMAGES_UPDATE" 1
.SH "NAME"
.HP
gcloud alpha compute images update \- update a Compute Engine image
.SH "SYNOPSIS"
.HP
\f5gcloud alpha compute images update\fR \fIIMAGE_NAME\fR [\fB\-\-architecture\fR=\fIARCHITECTURE\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-family\fR=\fIFAMILY\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fB\-\-clear\-user\-licenses\fR\ |\ \fB\-\-update\-user\-licenses\fR=[\fILICENSE\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR \fBgcloud alpha compute images update\fR updates labels for a
Compute Engine image.
.SH "EXAMPLES"
To update labels \f5\fIk0\fR\fR and \f5\fIk1\fR\fR and remove labels with key
\f5\fIk3\fR\fR, run:
.RS 2m
$ gcloud alpha compute images update example\-image \e
\-\-update\-labels=k0=value1,k1=value2 \-\-remove\-labels=k3
.RE
.RS 2m
k0 and k1 will be added as new labels if not already present.
.RE
Labels can be used to identify the image and to filter them like:
.RS 2m
$ gcloud alpha compute images list \-\-filter='labels.k1:value2'
.RE
To list only the labels when describing a resource, use \-\-format:
.RS 2m
$ gcloud alpha compute images describe example\-image \e
\-\-format="default(labels)"
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
\fIIMAGE_NAME\fR
Name of the disk image to update.
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-architecture\fR=\fIARCHITECTURE\fR
Specifies the architecture or processor type that this image can support. For
available processor types on Compute Engine, see
https://cloud.google.com/compute/docs/cpu\-platforms. \fIARCHITECTURE\fR must be
one of: \fBARM64\fR, \fBX86_64\fR.
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR
An optional text description for the image.
.TP 2m
\fB\-\-family\fR=\fIFAMILY\fR
Name of the image family to use. If an image family is specified when you create
an instance or disk, the latest non\-deprecated image in the family is used.
.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 compute images 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 compute images 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\-user\-licenses\fR
Remove all existing user licenses on an image.
.TP 2m
\fB\-\-update\-user\-licenses\fR=[\fILICENSE\fR,...]
List of user licenses to be updated on an image. These user licenses replace all
existing user licenses. If this flag is not provided, all existing user licenses
remain unchanged.
.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. These variants are also available:
.RS 2m
$ gcloud compute images update
.RE
.RS 2m
$ gcloud beta compute images update
.RE