.TH "GCLOUD_COMPUTE_INSTANCES_STOP" 1



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



.SH "SYNOPSIS"
.HP
\f5gcloud compute instances stop\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"

\fBgcloud compute instances stop\fR is used to stop a Compute Engine virtual
machine. Stopping a VM performs a clean shutdown, much like invoking the
shutdown functionality of a workstation or laptop.

If a VM has any attached Local SSD disks, you must use the
\f5\-\-discard\-local\-ssd\fR flag to indicate whether or not the Local SSD data
should be discarded. To stop the VM and preserve the Local SSD data when you
stop the VM by setting \f5\-\-discard\-local\-ssd=False\fR.

To stop the VM and discard the Local SSD data, specify
\f5\-\-discard\-local\-ssd=True\fR.

Preserving the Local SSD disk data incurs costs and is subject to limitations.
See https://cloud.google.com/compute/docs/disks/local\-ssd#stop_instance for
more information.

Stopping a VM which is already stopped will return without errors.



.SH "EXAMPLES"

To stop an instance named \f5test\-instance\fR, run:

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

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

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

Using '\-\-discard\-local\-ssd' without a value defaults to True.



.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"

These variants are also available:

.RS 2m
$ gcloud alpha compute instances stop
.RE

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