gcloud alpha compute tpus tpu-vm scp Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha compute tpus tpu-vm scp - copy files to and from a Cloud TPU VM via SCP
- SYNOPSIS
gcloud alpha compute tpus tpu-vm scp[[USER@]INSTANCE:]SRC[[[USER@]INSTANCE:]SRC…][[USER@]INSTANCE:]DEST[--batch-size=BATCH_SIZE; default="all"][--compress][--dry-run][--force-key-file-overwrite][--plain][--recurse][--scp-flag=SCP_FLAG][--ssh-key-file=SSH_KEY_FILE][--strict-host-key-checking=STRICT_HOST_KEY_CHECKING][--worker=WORKER; default="0"][--zone=ZONE][--internal-ip|--tunnel-through-iap][--ssh-key-expiration=SSH_KEY_EXPIRATION|--ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Copy files to and from a Cloud TPU VM via SCP (Alpha).- EXAMPLES
- To copy a file (for example, a text file in the local home directory) to a CloudTPU VM, run:
gcloudalphacomputetpustpu-vmscp~/my-filemy-tpu:To copy a file into all workers in a Cloud TPU VM, run:
gcloudalphacomputetpustpu-vmscp~/my-filemy-tpu:--worker=allTo copy a file from a Cloud TPU VM to the home directory of the local computer,run:
gcloudalphacomputetpustpu-vmscpmy-tpu:~/my-file~/To copy all files in a folder to a Cloud TPU VM, run:
gcloudalphacomputetpustpu-vmscp~/my-folder/my-tpu:--recurse - POSITIONAL ARGUMENTS
- [[
USER@]INSTANCE:]SRC[[[USER@]INSTANCE:]SRC…] - Specifies the files to copy.
- [[
USER@]INSTANCE:]DEST - Specifies a destination for the source files.
- [[
- FLAGS
--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
--workerflag, 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--workerflag. Maximumvalue of this flag should not be more than the number of specified workers,otherwise the value will be treated as ``--batch-size=all``. --compress- Enable compression.
--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 of
ssh(1)/scp(1)flags. This flag is useful if you want to take care of authentication yourselfor use specific ssh/scp features. --recurse- Upload directories recursively.
--scp-flag=SCP_FLAG- Additional flags to be passed to
scp(1). This flag may be repeated. --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_CHECKINGmust 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 scp. If not specified and the
property isn't set, you mightbe prompted to select a zone (interactive mode only).compute/zoneTo avoid prompting when this flag is omitted, you can set the
property:compute/zonegcloudconfigsetcompute/zoneZONEA list of zones can be fetched by running:
gcloudcomputezoneslistTo unset the property, run:
gcloudconfigunsetcompute/zoneAlternatively, the zone can be stored in the environment variable
.CLOUDSDK_COMPUTE_ZONE - 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.
- 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 helpfor 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. This variant is also available:
gcloudcomputetpustpu-vmscp
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-05-07 UTC.