gcloud alpha compute tpus tpu-vm ssh - SSH into a Cloud TPU VM

gcloud alpha compute tpus tpu-vm ssh[USER@]TPU[--batch-size=BATCH_SIZE; default="all"][--dry-run][--force-key-file-overwrite][--plain][--ssh-flag=SSH_FLAG][--ssh-key-file=SSH_KEY_FILE][--strict-host-key-checking=STRICT_HOST_KEY_CHECKING][--worker=WORKER; default="0"][--zone=ZONE][--command=COMMAND--output-directory=OUTPUT_DIRECTORY][--internal-ip    |--tunnel-through-iap][--ssh-key-expiration=SSH_KEY_EXPIRATION    |--ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER][GCLOUD_WIDE_FLAG …][--SSH_ARGS …]

gcloudalphacomputetpustpu-vmsshmy-tpu

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

gcloudalphacomputetpustpu-vmsshmy-tpu--worker=1

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

gcloudalphacomputetpustpu-vmsshmy-tpu--command="last boot"

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

gcloudalphacomputetpustpu-vmsshmy-tpu--command="last boot"--worker=all

[USER@]TPU

Specifies the Cloud TPU VM to SSH into.

USER specifies the username with which toSSH. If omitted, the user login name is used.

TPU specifies the name of the Cloud TPU VMto SSH into.

[--SSH_ARGS …]

Flags and positionals passed to the underlying ssh implementation.The '--' argument must be specified between gcloud specific args on the left andSSH_ARGS on the right. Example:

gcloudalphacomputetpustpu-vmsshexample-instance--zone=us-central1-a---vvv-L80:%TPU%:80

--batch-size=BATCH_SIZE; default="all"

Batch size for simultaneous command execution on the client's side. When using acomma-separated list (e.g. '1,4,6') or a range (e.g. '1-3') or ``all`` keywordin--worker flag, it executes the command concurrently in groups ofthe batch size. This flag takes a value greater than 0 to specify the batch sizeto control the concurrent connections that can be established with the TPUworkers, or the special keyword ``all`` to allow the concurrent commandexecutions on all the specified workers in--worker flag. Maximumvalue of this flag should not be more than the number of specified workers,otherwise the value will be treated as ``--batch-size=all``.

--dry-run

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

--force-key-file-overwrite

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

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

--plain

Suppress the automatic addition ofssh(1)/scp(1)flags. This flag is useful if you want to take care of authentication yourselfor use specific ssh/scp features.

--ssh-flag=SSH_FLAG

Additional flags to be passed tossh(1). It is recommended thatflags be passed using an assignment operator and quotes. Example:

gcloudalphacomputetpustpu-vmsshexample-instance--zone=us-central1-a--ssh-flag="-vvv"--ssh-flag="-L 80:localhost:80"

This flag will replace occurences of%USER%and%TPU% with their dereferenced values.For example, passing ``80:%TPU%:80`` into the flag is equivalent to passing80:162.222.181.197:80 tossh(1) if the external IP address of 'example-instance' is162.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.

--ssh-key-file=SSH_KEY_FILE

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

--strict-host-key-checking=STRICT_HOST_KEY_CHECKING

Override the default behavior of StrictHostKeyChecking for the connection. Bydefault, StrictHostKeyChecking is set to 'no' the first time you connect to aninstance, and will be set to 'yes' for all subsequent connections.STRICT_HOST_KEY_CHECKING must be one of:yes,no,ask.

--worker=WORKER; default="0"

TPU worker to connect to. The supported value is a single 0-based index of theworker in the case of a TPU Pod. When also using the--commandflag, 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 eachof the specified workers.

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

--zone=ZONE

Zone of the tpu to ssh. If not specified and thecompute/zone property isn't set, you mightbe prompted to select a zone (interactive mode only).

To avoid prompting when this flag is omitted, you can set thecompute/zone property:

gcloudconfigsetcompute/zoneZONE

A list of zones can be fetched by running:

gcloudcomputezoneslist

To unset the property, run:

gcloudconfigunsetcompute/zone

Alternatively, the zone can be stored in the environment variableCLOUDSDK_COMPUTE_ZONE.

These arguments are used to run commands using SSH.

--command=COMMAND

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 workersspecified with the--worker flag (defaults to worker 0 if not set).

--output-directory=OUTPUT_DIRECTORY

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".

At most one of these can be specified:

--internal-ip

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

--tunnel-through-iap

Tunnel the SSH connection through Cloud Identity-Aware Proxy for TCP forwarding.

This flag must be specified to attempt to connect via IAP tunneling. If it isnot set, and connection to a Cloud TPU VM without external IP address isattempted from outside the network, then the command will fail.

To use IAP tunneling, there must be firewall access to the SSH port for the IAPTCP IP address range for the network the TPU is created in. See theuser guide formore details.

To learn more, see theIAP for TCPforwarding documentation.

At most one of these can be specified:

--ssh-key-expiration=SSH_KEY_EXPIRATION

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 OSLogin. See $gcloud topicdatetimes for information on time formats.

--ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER

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 forinformation on duration formats.

Run$gcloud help for details.