.TH "GCLOUD_ALPHA_COMPUTE_INSTANCES_SUSPEND" 1



.SH "NAME"
.HP
gcloud alpha compute instances suspend \- suspend a virtual machine instance



.SH "SYNOPSIS"
.HP
\f5gcloud alpha compute instances suspend\fR \fIINSTANCE_NAMES\fR [\fIINSTANCE_NAMES\fR\ ...] [\fB\-\-async\fR] [\fB\-\-discard\-local\-ssd\fR[=\fIDISCARD_LOCAL_SSD\fR]] [\fB\-\-zone\fR=\fIZONE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR \fBgcloud alpha compute instances suspend\fR is used to suspend a
Compute Engine virtual machine. Suspending a VM is the equivalent of sleep or
standby mode: the guest receives an ACPI S3 suspend signal, after which all VM
state is saved to temporary storage. An instance can only be suspended while it
is in the RUNNING state. A suspended instance will be put in SUSPENDED state.

Note: A suspended instance can be resumed by running the gcloud compute
instances resume command.

If a VM has any attached Local SSD disks, you can preserve the Local SSD data
when you suspend the VM by setting \f5\-\-discard\-local\-ssd=False\fR.
Preserving the Local SSD disk data incurs costs and is subject to limitations.

Limitations:

.RS 2m
.IP "\(bu" 2m
Limitations for suspending a VM:
https://cloud.google.com/compute/docs/instances/suspend\-resume\-instance#limitations
.IP "\(bu" 2m
Limitations for preserving Local SSD data:
https://cloud.google.com/compute/docs/disks/local\-ssd#stop_instance
.RE
.sp



.SH "EXAMPLES"

To suspend an instance named \f5\fItest\-instance\fR\fR, run:

.RS 2m
$ gcloud alpha compute instances suspend test\-instance
.RE

To suspend an instance named \f5test\-instance\fR that has a Local SSD, run:

.RS 2m
$ gcloud alpha compute instances suspend test\-instance \e
    \-\-discard\-local\-ssd=True
.RE

Using \f5\-\-discard\-local\-ssd\fR without a value defaults to \f5True\fR.



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIINSTANCE_NAMES\fR [\fIINSTANCE_NAMES\fR ...]

Names of the instances 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 "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-discard\-local\-ssd\fR[=\fIDISCARD_LOCAL_SSD\fR]

If set to true, local SSD data is discarded.

.TP 2m
\fB\-\-zone\fR=\fIZONE\fR

Zone of the instances 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"

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 instances suspend
.RE

.RS 2m
$ gcloud beta compute instances suspend
.RE