gcloud alpha workstations start-tcp-tunnel

NAME
gcloud alpha workstations start-tcp-tunnel - start a tunnel through which a local process can forward TCP traffic to the workstation
SYNOPSIS
gcloud alpha 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
(ALPHA) Start a tunnel through which a local process can forwardTCP traffic to the workstation.

Note that arguments for theNO_PROXY environment variable must beFQDNs.

EXAMPLES
To start a tunnel to port 22 on a workstation, run:
gcloudalphaworkstationsstart-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 theproject attribute:

  • provide the argumentworkstation on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

WORKSTATION
ID of the workstation or fully qualified identifier for the workstation.

To set theworkstation attribute:

  • provide the argumentworkstation on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--cluster=CLUSTER
The cluster for the workstation.

To set thecluster attribute:

  • provide the argumentworkstation on the command line with a fullyspecified name;
  • provide the argument--cluster on the command line;
  • set the propertyworkstations/cluster.
--config=CONFIG
The config for the workstation.

To set theconfig attribute:

  • provide the argumentworkstation on the command line with a fullyspecified name;
  • provide the argument--config on the command line;
  • set the propertyworkstations/config.
--region=REGION
The region for the workstation.

To set theregion attribute:

  • provide the argumentworkstation on the command line with a fullyspecified name;
  • provide the argument--region on the command line;
  • set the propertyworkstations/region.
WORKSTATION_PORT
The port on the workstation to which traffic should be sent.
FLAGS
--local-host-port=LOCAL_HOST_PORT; default="localhost:0"
LOCAL_HOST:LOCAL_PORT on which gcloud should bind and listen forconnections that should be tunneled.

LOCAL_PORT may 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.

IfLOCAL_PORT is 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 help for 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:
gcloudworkstationsstart-tcp-tunnel
gcloudbetaworkstationsstart-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.