mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 10:35:03 +00:00
115 lines
4 KiB
Text
115 lines
4 KiB
Text
NAME
|
|
gcloud alpha workstations ssh - SSH into a running workstation
|
|
|
|
SYNOPSIS
|
|
gcloud alpha workstations ssh
|
|
(WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION)
|
|
[--command=COMMAND] [--port=PORT; default=22]
|
|
[--user=USER; default="user"] [GCLOUD_WIDE_FLAG ...] [-- SSH_ARGS ...]
|
|
|
|
DESCRIPTION
|
|
(ALPHA) SSH into a running workstation.
|
|
|
|
EXAMPLES
|
|
To ssh into a running workstation, run:
|
|
|
|
$ gcloud alpha workstations ssh WORKSTATION
|
|
|
|
To specify the workstation port, run:
|
|
|
|
$ gcloud alpha workstations ssh WORKSTATION --port=22
|
|
|
|
To ssh into a running workstation with a username, run:
|
|
|
|
$ gcloud alpha workstations ssh WORKSTATION --user=my-user
|
|
|
|
To run a command on the workstation, such as getting a snapshot of the
|
|
guest's process tree, run: $ gcloud alpha workstations ssh WORKSTATION --command="ps -ejH"
|
|
|
|
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 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;
|
|
▸ set the property workstations/cluster.
|
|
|
|
--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;
|
|
▸ set the property workstations/config.
|
|
|
|
--region=REGION
|
|
The location 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;
|
|
▸ set the property workstations/region.
|
|
|
|
[-- SSH_ARGS ...]
|
|
Flags and positionals passed to the underlying ssh implementation.
|
|
|
|
The '--' argument must be specified between gcloud specific args on the
|
|
left and SSH_ARGS on the right.
|
|
|
|
FLAGS
|
|
--command=COMMAND
|
|
A command to run on the workstation.
|
|
|
|
Runs the command on the target workstation and then exits.
|
|
|
|
--port=PORT; default=22
|
|
The port on the workstation to which traffic should be sent.
|
|
|
|
--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 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. These variants are also available:
|
|
|
|
$ gcloud workstations ssh
|
|
|
|
$ gcloud beta workstations ssh
|
|
|