Skip to main content

replicated vm ssh-endpoint

Get the SSH endpoint of a VM

Synopsis​

Get the SSH endpoint and port of a VM.

The output will be in the format: ssh://username@hostname:port

You can identify the VM either by its unique ID or by its name.

By default, the username in the endpoint is the GitHub username linked to your Vendor Portal account. If the VM was created with 'replicated vm create --ssh-public-key', the Linux user on the VM is derived from the key's comment (the portion before the first '@') instead — pass that username via --username so the endpoint matches the user the key was added to.

Note: SSH endpoints can only be retrieved from VMs in the "running" state.

VMs are currently a beta feature.

replicated vm ssh-endpoint VM_ID_OR_NAME [flags]

Examples​

# Get SSH endpoint for a specific VM by ID
replicated vm ssh-endpoint aaaaa11

# Get SSH endpoint for a specific VM by name
replicated vm ssh-endpoint my-test-vm

# Get SSH endpoint with a custom username
replicated vm ssh-endpoint my-test-vm --username custom-user

# Use the endpoint to SSH to a VM by name
ssh $(replicated vm ssh-endpoint my-test-vm)

Options​

  -h, --help              help for ssh-endpoint
      --username string   Custom username to use in SSH endpoint instead of the GitHub username set in Vendor Portal. If the VM was created with 'replicated vm create --ssh-public-key', set this to the username derived from the key's comment (the portion before the first '@') so the endpoint matches the user the key was added to.

Options inherited from parent commands​

      --app string       The app slug or app id to use in all calls
      --debug            Enable debug output
      --profile string   The authentication profile to use for this command
      --token string     The API token to use to access your app in the Vendor API

SEE ALSO​

On this page