gcloud workstations start-tcp-tunnel Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud workstations start-tcp-tunnel - start a tunnel through which a local process can forward TCP traffic to the workstation
- SYNOPSIS
gcloud workstations start-tcp-tunnel(WORKSTATION:--cluster=CLUSTER--config=CONFIG--region=REGION)WORKSTATION_PORT[--local-host-port=LOCAL_HOST_PORT; default="localhost:0"][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Start a tunnel through which a local process can forward TCP traffic to theworkstation.
Note that arguments for the
NO_PROXYenvironment variable must beFQDNs. - EXAMPLES
- To start a tunnel to port 22 on a workstation, run:
gcloudworkstationsstart-tcp-tunnel--project=my-project--region=us-central1--cluster=my-cluster--config=my-configmy-workstation22 - 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
WORKSTATION_PORT- The port on the workstation to which traffic should be sent.
- 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
--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.
- 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
- These variants are also available:
gcloudalphaworkstationsstart-tcp-tunnelgcloudbetaworkstationsstart-tcp-tunnel
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.