doctl compute ssh
Generated on 9 Apr 2025
from doctl version
v1.124.0
Usage
doctl compute ssh <droplet-id|name> [flags]Description
Access a Droplet using SSH by providing its ID or name.
You may specify the user to login with by passing the --ssh-user flag. To access the Droplet on a non-default port, use the --ssh-port flag. By default, the connection will be made to the Droplet’s public IP address. In order access it using its private IP address, use the --ssh-private-ip flag.
Flags
| Option | Description |
|---|---|
--help, -h |
Help for this command |
--ssh-agent-forwarding |
Enable SSH agent forwarding Default: false |
--ssh-command |
Command to execute on Droplet |
--ssh-key-path |
Path to SSH private key |
--ssh-port |
The remote port sshd is running on Default: 22 |
--ssh-private-ip |
SSH to Droplet’s private IP address Default: false |
--ssh-retry-max |
Max number of retries for a successful SSH connection to a Droplet (default is 0) Default: 0 |
--ssh-user |
SSH user for connection Default: root |
Related Commands
| Command | Description |
|---|---|
| doctl compute | Display commands that manage infrastructure |
Global Flags
| Option | Description |
|---|---|
--access-token, -t |
API V2 access token |
--api-url, -u |
Override default API endpoint |
--config, -c |
Specify a custom config file Default: |
--context |
Specify a custom authentication context name |
--http-retry-max |
Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5 |
--http-retry-wait-max |
Set the minimum number of seconds to wait before retrying a failed request
Default: 30 |
--http-retry-wait-min |
Set the maximum number of seconds to wait before retrying a failed request
Default: 1 |
--interactive |
Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false |
--output, -o |
Desired output format [text|json] Default: text |
--trace |
Show a log of network activity while performing a command Default: false |
--verbose, -v |
Enable verbose output Default: false |