gcloud alpha workstations ssh Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha workstations ssh - SSH into a running workstation
- SYNOPSIS
gcloud alpha workstations ssh(WORKSTATION:--cluster=CLUSTER--config=CONFIG--region=REGION)[--command=COMMAND][--local-host-port=LOCAL_HOST_PORT; default="localhost:0"][--port=PORT; default=22][--ssh-flag=SSH_FLAG][--user=USER; default="user"][GCLOUD_WIDE_FLAG …][--SSH_ARGS…]
- DESCRIPTION
(ALPHA)SSH into a running workstation.Note that arguments for the
NO_PROXYenvironment variable must beFQDNs.- EXAMPLES
- To ssh into a running workstation, run:
gcloudalphaworkstationssshWORKSTATIONTo specify the workstation port, run:
gcloudalphaworkstationssshWORKSTATION--port=22To ssh into a running workstation with a username, run:
gcloudalphaworkstationssshWORKSTATION--user=my-userTo run a command on the workstation, such as getting a snapshot of the guest'sprocess tree, run:
gcloudalphaworkstationssshWORKSTATION--command="ps -ejH" - POSITIONAL ARGUMENTS
- Workstation resource - The group of arguments defining a workstation Thearguments 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 inother ways.
To set the
projectattribute:- provide the argument
workstationon the command line with a fullyspecified 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 thisgroup 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 fullyspecified 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 fullyspecified 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 fullyspecified name; - provide the argument
--regionon the command line; - set the property
workstations/region.
- provide the argument
- provide the argument
- [--
SSH_ARGS…] - Flags and positionals passed to the underlying ssh implementation.
The '--' argument must be specified between gcloud specific args on the left andSSH_ARGS on the right.
- Workstation resource - The group of arguments defining a workstation Thearguments 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 inother ways.
- FLAGS
--command=COMMAND- A command to run on the workstation.
Runs the command on the target workstation and then exits.
--local-host-port=LOCAL_HOST_PORT; default="localhost:0"LOCAL_HOST:LOCAL_PORTon which gcloud should bind and listen forconnections that should be tunneled.LOCAL_PORTmay be omitted, in which case it is treated as 0 and anarbitrary unused local port is chosen. The colon also may be omitted in thatcase.If
LOCAL_PORTis 0, an arbitrary unused local port is chosen.--port=PORT; default=22- The port on the workstation to which traffic should be sent.
--ssh-flag=SSH_FLAG- Additional flags to be passed to
ssh(1). It is recommended thatflags be passed using an assignment operator and quotes. Example:gcloudalphaworkstationsssh--ssh-flag="-vvv"--ssh-flag="-L 80:localhost:80" --user=USER; default="user"- The username with which to SSH.
- 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:
gcloudworkstationssshgcloudbetaworkstationsssh
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-09-30 UTC.