- NAME
-
- gcloud workstations start - start a workstation
- SYNOPSIS
-
-
gcloud workstations start(WORKSTATION:--cluster=CLUSTER--config=CONFIG--region=REGION) [--async] [--endpoint-mode=ENDPOINT_MODE] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Start a workstation.
- EXAMPLES
-
To start (or resume) a workstation, run
gcloud workstations start WORKSTATION - POSITIONAL ARGUMENTS
-
-
Workstation resource - The group of arguments defining a workstation The
arguments in this group can be used to specify the attributes of this resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
To set the
projectattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
WORKSTATION-
ID of the workstation or fully qualified identifier for the workstation.
To set the
workstationattribute:-
provide the argument
workstationon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--cluster=CLUSTER-
The cluster for the workstation.
To set the
clusterattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--clusteron the command line; -
set the property
workstations/cluster.
-
provide the argument
--config=CONFIG-
The config for the workstation.
To set the
configattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--configon the command line; -
set the property
workstations/config.
-
provide the argument
--region=REGION-
The region for the workstation.
To set the
regionattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--regionon the command line; -
set the property
workstations/region.
-
provide the argument
-
provide the argument
-
Workstation resource - The group of arguments defining a workstation The
arguments in this group can be used to specify the attributes of this resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
- FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--endpoint-mode=ENDPOINT_MODE-
Specifies endpoint mode for a given command. Regional endpoints provide enhanced
data residency and reliability by ensuring your request is handled entirely
within the specified Google Cloud region. This differs from global endpoints,
which may process parts of the request outside the target region. Overrides the
default
regional/endpoint_modeproperty value for this command invocation.ENDPOINT_MODEmust be one of:global- (Default) Use global rather than regional endpoints.
regional- Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred- Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
- 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. - REGIONAL ENDPOINTS
-
This command supports regional endpoints. To use regional endpoints for this
command, use the
--endpoint-mode=regional-preferredflag. To use regional endpoints by default, run$ gcloud config set regional/endpoint_mode regional-preferred. - NOTES
-
These variants are also available:
gcloud alpha workstations startgcloud beta workstations start
gcloud workstations start
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-09-29 UTC.