HEX

File: //snap/google-cloud-cli/current/help/man/man1/gcloud_alpha_compute_images_deprecate.1

.TH "GCLOUD_ALPHA_COMPUTE_IMAGES_DEPRECATE" 1

.SH "NAME"
.HP
gcloud alpha compute images deprecate \- manage deprecation status of Compute Engine images

.SH "SYNOPSIS"
.HP
\f5gcloud alpha compute images deprecate\fR \fIIMAGE_NAME\fR \fB\-\-state\fR=\fISTATE\fR [\fB\-\-replacement\fR=\fIREPLACEMENT\fR] [\fB\-\-delete\-in\fR=\fIDELETE_IN\fR\ |\ \fB\-\-delete\-on\fR=\fIDELETE_ON\fR] [\fB\-\-deprecate\-in\fR=\fIDEPRECATE_IN\fR\ |\ \fB\-\-deprecate\-on\fR=\fIDEPRECATE_ON\fR] [\fB\-\-obsolete\-in\fR=\fIOBSOLETE_IN\fR\ |\ \fB\-\-obsolete\-on\fR=\fIOBSOLETE_ON\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]

.SH "DESCRIPTION"

\fB(ALPHA)\fR \fBgcloud alpha compute images deprecate\fR is used to deprecate
images.

.SH "EXAMPLES"

To deprecate an image called 'IMAGE' immediately, mark it as obsolete in one
day, and mark it as deleted in two days, use:

.RS 2m
$ gcloud alpha compute images deprecate IMAGE \-\-state=DEPRECATED \e
\-\-obsolete\-in=1d \-\-delete\-in=2d
.RE

To un\-deprecate an image called 'IMAGE' and clear times for deprecated,
obsoleted, and deleted, use:

.RS 2m
$ gcloud alpha compute images deprecate IMAGE \-\-state=ACTIVE
.RE

.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIIMAGE_NAME\fR

Name of the disk image to operate on.

.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-state\fR=\fISTATE\fR

The deprecation state to set on the image. \fISTATE\fR must be one of:

.RS 2m
.TP 2m
\fBACTIVE\fR
The image is currently supported.
.TP 2m
\fBDELETED\fR
New uses result in an error. Setting this state will not automatically delete
the image. You must still make a request to delete the image to remove it from
the image list.
.TP 2m
\fBDEPRECATED\fR
Operations which create a new \fBDEPRECATED\fR resource return successfully, but
with a warning indicating that the image is deprecated and recommending its
replacement.
.TP 2m
\fBOBSOLETE\fR
New uses result in an error.
.RE
.sp

.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-replacement\fR=\fIREPLACEMENT\fR

Specifies a Compute Engine image as a replacement for the image being phased
out. Users of the deprecated image will be advised to switch to this
replacement. For example, \fB\-\-replacement example\-image\fR or
\fB\-\-replacement projects/google/global/images/example\-image\fR.

This flag value is purely informational and is not validated in any way.

.TP 2m

At most one of these can be specified:

.RS 2m
.TP 2m
\fB\-\-delete\-in\fR=\fIDELETE_IN\fR

Specifies a time duration in which the image should be marked as
\f5\fIDELETED\fR\fR.

Note: This is only informational and the image will not be deleted unless you
manually delete it.

For example, specifying \f5\fI30d\fR\fR sets the planned \f5\fIDELETED\fR\fR
time to 30 days from the current system time, but does not delete the image. You
must manually delete the image in 30 days. See $ gcloud topic datetimes for
information on duration formats.

This flag is mutually exclusive with \fB\-\-delete\-on\fR.

.TP 2m
\fB\-\-delete\-on\fR=\fIDELETE_ON\fR

Specifies a date when the image should be marked as \f5\fIDELETED\fR\fR.

Note: This is only informational and the image will not be deleted unless you
manually delete it.

This flag is mutually exclusive with \fB\-\-delete\-in\fR.

The date and time specified must be valid RFC 3339 full\-date or date\-time. For
times in UTC, this looks like \f5\fIYYYY\-MM\-DDTHH:MM:SSZ\fR\fR. For example:
2020\-01\-02T00:00:00Z for midnight on January 2, 2020 in UTC.

.RE
.sp
.TP 2m

At most one of these can be specified:

.RS 2m
.TP 2m
\fB\-\-deprecate\-in\fR=\fIDEPRECATE_IN\fR

Specifies a time duration in which the image should be marked as
\f5\fIDEPRECATED\fR\fR.

Note: This is only informational and the image will not be deprecated unless you
manually deprecate it.

This flag is mutually exclusive with \fB\-\-deprecate\-on\fR.

For example, specifying \f5\fI30d\fR\fR sets the planned \f5\fIDEPRECATED\fR\fR
date to 30 days from the current system time, but does not deprecate the image.
You must manually deprecate the image in 30 days. See $ gcloud topic datetimes
for information on duration formats.

.TP 2m
\fB\-\-deprecate\-on\fR=\fIDEPRECATE_ON\fR

Specifies a date when the image should be marked as DEPRECATED.

Note: This is only informational and the image will not be deprecated unless you
manually deprecate it.

This flag is mutually exclusive with \fB\-\-deprecate\-in\fR.

.RE
.sp
.TP 2m

At most one of these can be specified:

.RS 2m
.TP 2m
\fB\-\-obsolete\-in\fR=\fIOBSOLETE_IN\fR

Specifies a time duration in which the image should be marked as
\f5\fIOBSOLETE\fR\fR.

Note: This is only informational and the image will not be obsoleted unless you
manually obsolete it.

This flag is mutually exclusive with \fB\-\-obsolete\-on\fR.

For example, specifying \f5\fI30d\fR\fR sets the planned \f5\fIOBSOLETE\fR\fR
time to 30 days from the current system time, but does not obsolete the image.
You must manually obsolete the image in 30 days. See $ gcloud topic datetimes
for information on duration formats.

.TP 2m
\fB\-\-obsolete\-on\fR=\fIOBSOLETE_ON\fR

Specifies a date when the image should be marked as \f5\fIOBSOLETE\fR\fR.

Note: This is only informational and the image will not be obsoleted unless you
manually obsolete it.

This flag is mutually exclusive with \fB\-\-obsolete\-in\fR.

.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 deprecate
.RE

.RS 2m
$ gcloud beta compute images deprecate
.RE