[Contents] [Index]

Introduction >>     Configuration >>     Connecting >>         Quick Connect         Profiles >>         Key Generation >>         Connecting to a Remote Host Computer>>         Uploading Your Public Key >>         Using Public-Key Authentication         Tunneling Explained >>         Command Line Options     Terminal Window >>     File Transfer >>     Toolbar Reference >>     Menu Reference >>     Advanced Information >>     Troubleshooting >>     Appendices >>

Command Line Options

For some purposes it may be useful to operate SSH Secure Shell for Workstations from the command line (command prompt).

The command line syntax for SSH Secure Shell for Workstations () is the following:

sshclient [-r] [-p port] [-u user] [-h host] [profile.ssh2]

The meaning of the command line parameters is the following:

• -r

  The -r option will reset all customizations made to the user interface (toolbars and menus). A confirmation dialog will be displayed.

• -p [port_number]

  The -p option specifies the port number used for the connection. If this option is not specified, the port number defined in the default profile will be used.

• -u [user_name]

  The -u option specifies the user name for the connection. If this option is not specified, the user name defined in the default profile will be used.

• -h [host_name]

  The -h option specifies the host name for the connection. If this option is not specified, the host name defined in the default profile will be used.

• [profile.ssh2]

  If a profile is specified, it must the last option on the command line. Any command line parameters will override the profile settings. If no profile is specified, the default profile (default.ssh2) will be used.

For example, the following command would immediately start a connection to a host called remotehost and connect as guest. The port number is not specified, so the connection would use the port specified in the default profile.

sshclient -h remotehost -u guest

The following command would immediately start a connection to remotehost using the settings defined in the profile file custom.ssh2.

sshclient -h remotehost custom.ssh2

If the host is not specified (using the -h option) and no profile is specified, the login dialog will open, automatically filled with the values specified on the command line.

For example, the following command would display the login dialog with the port number already defined as 222 and the user name as guest.

sshclient -u guest -p 222

Note: A pure command line version of SSH Secure Shell for Workstations is shipped with the Windows client. The command line client SSH2.EXE is a port of the UNIX version of SSH Secure Shell for Workstations, and may be useful also in the Windows command line environment, especially for when creating scripts. For a more detailed description of the SSH2.EXE syntax, see Appendix SSH.EXE.

Also several other command line utilities are shipped with the Windows and command line clients. For more information, see the appendices section (Appendices).