1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00
gcloud-help/gcloud/alpha/workstations/start-tcp-tunnel
2022-09-28 10:27:48 +00:00

90 lines
3.6 KiB
Text

NAME
gcloud alpha workstations start-tcp-tunnel - starts 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) Starts a tunnel through which a local process can forward TCP
traffic to the workstation.
EXAMPLES
To start a tunnel to port 22 on a workstation, run:
$ gcloud alpha workstations start-tcp-tunnel --project=my-project \
--region=us-central1 --cluster=my-cluster --config=my-config \
my-workstation 22
POSITIONAL ARGUMENTS
Workstation resource - The workstation to which traffic should be sent.
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 project attribute:
◆ provide the argument workstation on the command line with a fully
specified name;
◆ provide the argument --project on 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 workstation attribute:
▸ provide the argument workstation on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--cluster=CLUSTER
The cluster for the workstation. To set the cluster attribute:
▸ provide the argument workstation on the command line with a fully
specified name;
▸ provide the argument --cluster on the command line.
--config=CONFIG
The config for the workstation. To set the config attribute:
▸ provide the argument workstation on the command line with a fully
specified name;
▸ provide the argument --config on the command line.
--region=REGION
The region for the workstation. To set the region attribute:
▸ provide the argument workstation on the command line with a fully
specified name;
▸ provide the argument --region on the command line.
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 for
connections that should be tunneled.
LOCAL_PORT may be omitted, in which case it is treated as 0 and an
arbitrary unused local port is chosen. The colon also may be omitted in
that case.
If LOCAL_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 this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud beta workstations start-tcp-tunnel