.TH "GCLOUD_COMPUTE_TPUS_TPU\-VM_SSH" 1



.SH "NAME"
.HP
gcloud compute tpus tpu\-vm ssh \- SSH into a Cloud TPU VM



.SH "SYNOPSIS"
.HP
\f5gcloud compute tpus tpu\-vm ssh\fR [\fIUSER\fR@]\fITPU\fR [\fB\-\-dry\-run\fR] [\fB\-\-force\-key\-file\-overwrite\fR] [\fB\-\-internal\-ip\fR] [\fB\-\-plain\fR] [\fB\-\-ssh\-flag\fR=\fISSH_FLAG\fR] [\fB\-\-ssh\-key\-file\fR=\fISSH_KEY_FILE\fR] [\fB\-\-strict\-host\-key\-checking\fR=\fISTRICT_HOST_KEY_CHECKING\fR] [\fB\-\-worker\fR=\fIWORKER\fR;\ default="0"] [\fB\-\-zone\fR=\fIZONE\fR] [\fB\-\-command\fR=\fICOMMAND\fR\ \fB\-\-output\-directory\fR=\fIOUTPUT_DIRECTORY\fR] [\fB\-\-ssh\-key\-expiration\fR=\fISSH_KEY_EXPIRATION\fR\ |\ \fB\-\-ssh\-key\-expire\-after\fR=\fISSH_KEY_EXPIRE_AFTER\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR] [\-\-\ \fISSH_ARGS\fR\ ...]



.SH "DESCRIPTION"

SSH into a Cloud TPU VM.



.SH "EXAMPLES"

To SSH into a Cloud TPU VM, run:

.RS 2m
$ gcloud compute tpus tpu\-vm ssh my\-tpu
.RE

To SSH into worker 1 on a Cloud TPU VM Pod, run:

.RS 2m
$ gcloud compute tpus tpu\-vm ssh my\-tpu \-\-worker=1
.RE

To run an SSH command in a Cloud TPU VM (for example, to print the time since
last boot), run:

.RS 2m
$ gcloud compute tpus tpu\-vm ssh my\-tpu \-\-command="last boot"
.RE

To run the same command in all workers in a Cloud TPU VM simultaneously, run:

.RS 2m
$ gcloud compute tpus tpu\-vm ssh my\-tpu \-\-command="last boot" \e
  \-\-worker=all
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
[\fIUSER\fR@]\fITPU\fR

Specifies the Cloud TPU VM to SSH into.

\f5\fIUSER\fR\fR specifies the username with which to SSH. If omitted, the user
login name is used.

\f5\fITPU\fR\fR specifies the name of the Cloud TPU VM to SSH into.

.TP 2m
[\-\- \fISSH_ARGS\fR ...]

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. Example:

.RS 2m
$ gcloud compute tpus tpu\-vm ssh example\-instance \e
\-\-zone=us\-central1\-a \-\- \-vvv \-L 80:%TPU%:80
.RE


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-dry\-run\fR

Print the equivalent scp/ssh command that would be run to stdout, instead of
executing it.

.TP 2m
\fB\-\-force\-key\-file\-overwrite\fR

If enabled, the gcloud command\-line tool will regenerate and overwrite the
files associated with a broken SSH key without asking for confirmation in both
interactive and non\-interactive environments.

If disabled, the files associated with a broken SSH key will not be regenerated
and will fail in both interactive and non\-interactive environments.

.TP 2m
\fB\-\-internal\-ip\fR

Connect to TPU VMs using their internal IP addresses rather than their external
IP addresses. Use this to connect from a Google Compute Engine VM to a TPU VM on
the same VPC network, or between two peered VPC networks.

.TP 2m
\fB\-\-plain\fR

Suppress the automatic addition of \fBssh(1)\fR/\fBscp(1)\fR flags. This flag is
useful if you want to take care of authentication yourself or use specific
ssh/scp features.

.TP 2m
\fB\-\-ssh\-flag\fR=\fISSH_FLAG\fR

Additional flags to be passed to \fBssh(1)\fR. It is recommended that flags be
passed using an assignment operator and quotes. Example:

.RS 2m
$ gcloud compute tpus tpu\-vm ssh example\-instance \e
    \-\-zone=us\-central1\-a \-\-ssh\-flag="\-vvv" \e
    \-\-ssh\-flag="\-L 80:localhost:80"
.RE

This flag will replace occurences of \f5\fI%USER%\fR\fR and \f5\fI%TPU%\fR\fR
with their dereferenced values. For example, passing ``80:%TPU%:80`` into the
flag is equivalent to passing \f5\fI80:162.222.181.197:80\fR\fR to \fBssh(1)\fR
if the external IP address of 'example\-instance' is 162.222.181.197.

If connecting to the instance's external IP, then %TPU% is replaced with that,
otherwise it is replaced with the internal IP.

.TP 2m
\fB\-\-ssh\-key\-file\fR=\fISSH_KEY_FILE\fR

The path to the SSH key file. By default, this is
\f5\fI~/.ssh/google_compute_engine\fR\fR.

.TP 2m
\fB\-\-strict\-host\-key\-checking\fR=\fISTRICT_HOST_KEY_CHECKING\fR

Override the default behavior of StrictHostKeyChecking for the connection. By
default, StrictHostKeyChecking is set to 'no' the first time you connect to an
instance, and will be set to 'yes' for all subsequent connections.
\fISTRICT_HOST_KEY_CHECKING\fR must be one of: \fByes\fR, \fBno\fR, \fBask\fR.

.TP 2m
\fB\-\-worker\fR=\fIWORKER\fR; default="0"

TPU worker to connect to. The supported value is a single 0\-based index of the
worker in the case of a TPU Pod. When also using the \f5\-\-command\fR flag, it
additionally supports a comma\-separated list (e.g. '1,4,6'), range (e.g.
\'1\-3'), or special keyword ``all" to run the command concurrently on each of
the specified workers.

Note that when targeting multiple workers, you should run 'ssh\-add' with your
private key prior to executing the gcloud command. Default: 'ssh\-add
~/.ssh/google_compute_engine'.

.TP 2m
\fB\-\-zone\fR=\fIZONE\fR

Zone of the tpu to ssh. If not specified and the \f5\fIcompute/zone\fR\fR
property isn't set, you might be prompted to select a zone (interactive mode
only).

To avoid prompting when this flag is omitted, you can set the
\f5\fIcompute/zone\fR\fR property:

.RS 2m
$ gcloud config set compute/zone ZONE
.RE

A list of zones can be fetched by running:

.RS 2m
$ gcloud compute zones list
.RE

To unset the property, run:

.RS 2m
$ gcloud config unset compute/zone
.RE

Alternatively, the zone can be stored in the environment variable
\f5\fICLOUDSDK_COMPUTE_ZONE\fR\fR.

.TP 2m

These arguments are used to run commands using SSH.


.RS 2m
.TP 2m
\fB\-\-command\fR=\fICOMMAND\fR

Command to run on the Cloud TPU VM.

Runs the command on the target Cloud TPU VM and then exits.

Note: in the case of a TPU Pod, it will only run the command in the workers
specified with the \f5\-\-worker\fR flag (defaults to worker 0 if not set).

.TP 2m
\fB\-\-output\-directory\fR=\fIOUTPUT_DIRECTORY\fR

Path to the directory to output the logs of the commands.

The path can be relative or absolute. The directory must already exist.

If not specified, standard output will be used.

The logs will be written in files named {WORKER_ID}.log. For example: "2.log".

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-ssh\-key\-expiration\fR=\fISSH_KEY_EXPIRATION\fR

The time when the ssh key will be valid until, such as
"2017\-08\-29T18:52:51.142Z." This is only valid if the instance is not using OS
Login. See $ gcloud topic datetimes for information on time formats.

.TP 2m
\fB\-\-ssh\-key\-expire\-after\fR=\fISSH_KEY_EXPIRE_AFTER\fR

The maximum length of time an SSH key is valid for once created and installed,
e.g. 2m for 2 minutes. See $ gcloud topic datetimes for information on duration
formats.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha compute tpus tpu\-vm ssh
.RE