gcloud alpha compute instances stop Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha compute instances stop - stop a virtual machine instance
- SYNOPSIS
gcloud alpha compute instances stopINSTANCE_NAMES[INSTANCE_NAMES…][--async][--discard-local-ssd[=DISCARD_LOCAL_SSD]][--no-graceful-shutdown][--zone=ZONE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)gcloud alpha compute instances stopis used tostop 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
--discard-local-ssdflag to indicate whether or not the Local SSDdata should be discarded. To stop the VM and preserve the Local SSD data whenyou stop the VM by setting--discard-local-ssd=False.To stop the VM and discard the Local SSD data, specify
--discard-local-ssd=True.Preserving the Local SSD disk data incurs costs and is subject to limitations.Seehttps://cloud.google.com/compute/docs/disks/local-ssd#stop_instancefor more information.
Stopping a VM which is already stopped will return without errors.
- EXAMPLES
- To stop an instance named
test-instance, run:gcloudalphacomputeinstancesstoptest-instanceTo stop an instance named
test-instancethat has a Local SSD, run:gcloudalphacomputeinstancesstoptest-instance--discard-local-ssd=TrueUsing '--discard-local-ssd' without a value defaults to True.
- POSITIONAL ARGUMENTS
INSTANCE_NAMES[INSTANCE_NAMES…]- Names of the instances to operate on. For details on valid instance names, referto the criteria documented under the field 'name' at:https://cloud.google.com/compute/docs/reference/rest/v1/instances
- FLAGS
--async- Return immediately, without waiting for the operation in progress to complete.
--discard-local-ssd[=DISCARD_LOCAL_SSD]- If set to true, local SSD data is discarded.
--no-graceful-shutdown- Stops the instance immediately without gracefully shutting it down. If agraceful shutdown is in progress, then the instance is forcefully stopped.
--zone=ZONE- Zone of the instances to operate on. If not specified, you might be prompted toselect a zone (interactive mode only).
gcloudattempts to identify theappropriate zone by searching for resources in your currently active project. Ifthe zone cannot be determined,gcloudprompts you for a selection withall available Google Cloud Platform zones.To avoid prompting when this flag is omitted, the user can set the
property:compute/zonegcloudconfigsetcompute/zoneZONEA list of zones can be fetched by running:
gcloudcomputezoneslistTo unset the property, run:
gcloudconfigunsetcompute/zoneAlternatively, the zone can be stored in the environment variable
.CLOUDSDK_COMPUTE_ZONE
- 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
$gcloud helpfor details. - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudcomputeinstancesstopgcloudbetacomputeinstancesstop
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.