gcloud compute config-ssh - populate SSH config files with Host entries from each instance

gcloud compute config-ssh[--dry-run][--force-key-file-overwrite][--remove][--ssh-config-file=SSH_CONFIG_FILE][--ssh-key-file=SSH_KEY_FILE][GCLOUD_WIDE_FLAG …]

In most cases, it is sufficient to run:

gcloudcomputeconfig-ssh

Each instance will be given an alias of the formNAME.ZONE.PROJECT.For example, ifexample-instance resides inus-central1-a, you can SSH to it by running:

sshexample-instance.us-central1-a.MY-PROJECT

On some platforms, the host alias can be tab-completed, making the long aliasless daunting to type.

The aliases created interface with SSH-based programs likescp(1),so it is possible to use the aliases elsewhere:

scp~/MY-FILEexample-instance.us-central1-a.MY-PROJECT:~

Whenever instances are added, removed, or their external IP addresses arechanged, the remove command must be run to clear the existing configuration andthen the command can set executed to set the configuration to the current state.

This command ensures that the user's public SSH key is present in the project'smetadata. If the user does not have a public SSH key, one is generated usingssh-keygen(1) (if the--quiet flag is given, thegenerated key will have an empty passphrase).

gcloudcomputeconfig-ssh

To remove the change to the SSH config file by this command, run:

gcloudcomputeconfig-ssh--remove

--dry-run

If provided, the proposed changes to the SSH config file are printed to standardoutput and no actual changes are made.

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

--remove

If provided, any changes made to the SSH config file by this tool are reverted.

--ssh-config-file=SSH_CONFIG_FILE

Specifies an alternative per-user SSH configuration file. By default, this is~/.ssh/config.

--ssh-key-file=SSH_KEY_FILE

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

Run$gcloud help for details.