SSH Command - Usage, Options, Configuration
sshcommand on Unix/Linux or the Mac terminal. For general information about SSH and other implementations, see the SSH protocol home page.
Practically every Unix and Linux system includes the
ssh command. This command is used to start the SSH client program that enables secure connection to the SSH server on a remote machine. The
ssh command is used from logging into the remote machine, transferring files between the two machines, and for executing commands on the remote machine.
ContentsSSH Command in Linux Other SSH Commands Using the Linux client Specifying a different user name Executing remote commands on the server SSH client configuration file Configuring public key authentication Configuring port forwarding SSH command line options A little history
SSH Command in Linux
ssh command provides a secure encrypted connection between two hosts over an insecure network. This connection can also be used for terminal access, file transfers, and for tunneling other applications. Graphical X11 applications can also be run securely over SSH from a remote location.
Other SSH Commands
There are other SSH commands besides the client
ssh. Each has its own page.
ssh-keygen - creates a key pair for public key authentication
ssh-copy-id - configures a public key as authorized on a server
ssh-agent - agent to hold private key for single sign-on
ssh-add - tool to add a key to the agent
scp - file transfer client with RCP-like command interface
sftp - file transfer client with FTP-like command interface
sshd - OpenSSH server
Using the Linux client
Linux typically uses the OpenSSH client. The ssh command to log into a remote machine is very simple. To log in to a remote computer called sample.ssh.com, type the following command at a shell prompt:
If this is the first time you use ssh to connect to this remote machine, you will see a message like:
The authenticity of host 'sample.ssh.com' cannot be established. DSA key fingerprint is 04:48:30:31:b0:f3:5a:9b:01:9d:b3:a7:38:e2:b1:0c. Are you sure you want to continue connecting (yes/no)?
yes to continue. This will add the server to your list of known hosts (
~/.ssh/known_hosts) as seen in the following message:
Warning: Permanently added 'sample.ssh.com' (DSA) to the list of known hosts.
Each server has a host key, and the above question related to verifying and saving the host key, so that next time you connect to the server, it can verify that it actually is the same server.
Once the server connection has been established, the user is authenticated. Typically, it asks for a password. For some servers, you may be required to type in a one-time password generated by a special hardware token.
Once authentication has been accepted, you will be at the shell prompt for the remote machine.
Specifying a different user name
It is also possible to use a different username at the remote machine by entering the command as:
The above can also be expressed with the syntax:
ssh -l alternative-username sample.ssh.com
Executing remote commands on the server
The ssh command is often also used to remotely execute commands on the remote machine without logging in to a shell prompt. The syntax for this is:
ssh hostname command
For example, to execute the command:
on host sample.ssh.com, type the following command at a shell prompt:
ssh sample.ssh.com ls /tmp/doc
After authenticating to the remote server, the contents of the remote directory will be displayed, and you will return to your local shell prompt. -x Disables X11 forwarding.
SSH client configuration file
ssh command reads its configuration from the SSH client configuration file
~/.ssh/config. For more information, see the page on SSH client configuration file.
Configuring public key authentication
Configuring port forwarding
Command-line options can be used to set up port forwarding. Local fowarding means that a local port (at the client computer) is tunneled to an IP address and port from the server. Remote forwarding means that a remote port (at the server computer) is forwarded to a given IP address and port from the client machine. See the page on configuring port forwarding on how to configure them.
OpenSSH also supports forwarding Unix domain sockets and IP packets from a tunnel device to establish a VPN (Virtual Private Network).
SSH command line options
Some of the most important command-line options for the OpenSSH client are:
-1 Use protocol version 1 only.
-2 Use protocol version 2 only.
-4 Use IPv4 addresses only.
-6 Use IPv6 addresses only.
-A Enable forwarding of the authentication agent connection.
-a Disable forwarding of the authentication agent connection.
-C Use data compression
-c cipher_spec Selects the cipher specification for encrypting the session.
[bind_address:]port Dynamic application-level port forwarding. This allocates a socket to listen to port on the local side. When a connection is made to this port, the connection is forwarded over the secure channel, and the application protocol is then used to determine where to connect to from the remote machine.
-E log_file Append debug logs to log_file instead of standard error.
-F configfile Specifies a per-user configuration file. The default for the per-user configuration file is ~/.ssh/config.
-g Allows remote hosts to connect to local forwarded ports.
[:port] Connect to the target host by first making a ssh connection to the pjump host[(/iam/jump-host) and then establishing a TCP forwarding to the ultimate destination from there.
-l login_name Specifies the user to log in as on the remote machine.
-p port Port to connect to on the remote host.
-q Quiet mode.
-V Display the version number.
-v Verbose mode.
-X Enables X11 forwarding.
A little history
The following video summarizes how and why SSH was originally developed.