Teraterm connect command

Connects.

connect <command line parameters>

Remarks

If MACRO is not linked to Tera Term, this command runs Tera Term with <command line parameters>, and links it to MACRO. For example:

msg = 'box106.firma.com:22 /ssh /auth=publickey /user=root /keyfile=RSA\id_rsa'
connect msg

If MACRO has already been linked to Tera Term and Tera Term is not connected to the host, this command causes Tera Term to connect to the host specified by <command line parameters>.

If MACRO has already been linked to Tera Term and Tera Term has already been connected to the host, this command is ignored.

As a result of this command, the system variable "result" is set to one of the following values depending on the link and connection status:

To test the current link and connect status before executing the "connect" command, use the "testlink" command.

Communication commands except "connect", "cygconnect" and "testlink" can not be executed before the link is established.

Connection method

There are 3 types of connection you can establish from Tera Term macro:

• Telnet connection (port 23)
• SSH1 or SSH2 connection (port 22)
• General connection
• Connection via COM port

Telnet connections

connect 'myserver:23 /nossh'
connect 'myserver:23 /telnet'
connect 'myserver:23'

Using /nossh is strongly recommended. Without this parameter Tera Term will start connecting with the same method (telnet or SSH) that was used during last time when teraterm.ini file was saved. In case it was SSH than your macro will try to connect via SSH and will eventually fail.

SSH connections

connect 'myserver /ssh'

This way will start SSH connection without defining whether SSH1 or SSH2 has to be used.

connect 'myserver /ssh /1' # outdated, not recommended unless absolutely necessary
connect 'myserver /ssh /2'

Parameters /1 and /2 force to use SSH1 or SSH2 method.

connect 'myserver /ssh /auth=password /user=username /passwd=password'
connect 'myserver /ssh /2 /auth=password /user=username /passwd=password'
connect 'myserver /ssh /auth=publickey /user=username /passwd=password /keyfile=private-key-file'
connect 'myserver /ssh /2 /auth=publickey /user=username /passwd=password /keyfile=private-key-file'
connect 'myserver /ssh /auth=challenge /user=username /passwd=password'
connect 'myserver /ssh /2 /auth=challenge /user=username /passwd=password'

Note: path to /keyfile should be relative to Teraterm directory. Absiolute path does not work.

Above 9 ways allow to skip popup dialog and pass username and password directly from macro. Please note that /auth=password or /auth=publickey or /auth=challenge is the parameter saying that authentication will be done by entering password or private-key-file thus you should not replace the word 'password' or the word 'publickey' in it with actual password.

connect 'myserver /ssh /auth=pageant /user=username'
connect 'myserver /ssh /2 /auth=pageant /user=username'

Above 3 ways allow to skip popup dialog and pass username directly from macro.

connect 'myserve /ssh /auth=password /user=username /ask4passwd'
connect 'myserver /ssh /1 /auth=password /user=username /ask4passwd'
connect 'myserver /ssh /2 /auth=password /user=username /ask4passwd'
connect 'myserver /ssh /auth=publickey /user=username /ask4passwd /keyfile=private-key-file'
connect 'myserver /ssh /1 /auth=publickey /user=username /ask4passwd /keyfile=private-key-file'
connect 'myserver /ssh /2 /auth=publickey /user=username /ask4passwd /keyfile=private-key-file'
connect 'myserve /ssh /auth=challenge /user=username /ask4passwd'
connect 'myserver /ssh /1 /auth=challenge /user=username /ask4passwd'
connect 'myserver /ssh /2 /auth=challenge /user=username /ask4passwd'

Above 9 ways pass username and authentication method directly from macro, and the popup asks for password.

General connection

connect 'myserver /timeout=<value>'

Note: This option value is connecting timeout value(per seconds). Connecting to myserver could be canceled after timeout has occurred with the specified value. Conversely, no action if the value is zero. The default value is zero. Also this value would be saved as `ConnectingTimeout' entry in teraterm.ini file.

Connections via COM port

connect '/C=x'

Here x represents COM port number. For example to connect via COM port 1 the command will look like: connect '/C=1'

Examples

; No command line parameter
connect ''

; Timeout will occur if connection does not succeed within five seconds.
connect 'myserver /timeout=5'

; Run Tera Term and open telnet session
connect 'myserver:23 /nossh'

; Run Tera Term and open SSH session
connect 'myserver /ssh'

; Run Tera Term and open SSH1 session
connect 'myserver /ssh /1'

; Run Tera Term and open SSH2 session
connect 'myserver /ssh /2'

; Run Tera Term,open SSH session and do not prompt for user name and password
connect 'myserver /ssh /auth=password /user=username /passwd=password'

; Run Tera Term, open SSH1 session and do not prompt for user name and password
connect 'myserver /ssh /1 /auth=password /user=username /passwd=password'

; Run Tera Term, open SSH2 session and do not prompt for user name and password
connect 'myserver /ssh /2 /auth=password /user=username /passwd=password'

; Run Tera Term, open SSH session and, not prompt for user name and password and use private key file
connect 'myserver /ssh /auth=publickey/user=username /passwd=password /keyfile=private-key-file'

; Run Tera Term, open SSH1 session and, not prompt for user name and password and use private key file
connect 'myserver /ssh /1 /auth=publickey/user=username /passwd=password /keyfile=private-key-file'

; Run Tera Term, open SSH2 session and, not prompt for user name and password and use private key file
connect 'myserver /ssh /2 /auth=publickey /user=username /passwd=password /keyfile=private-key-file'

; Tera Term automatically connects the remote host with the public key 
; authentication, and not prompt for user name and password and use private key file.
connect 'myserver /ssh /auth=pageant /user=username'

; RunTera Term and open serial port connection. Port number is x=1..256
connect '/C=x'

CommandLine = '111.111.11.11'
connect CommandLine

; Sample macro for Tera Term
;  Telnet login

; open Tera Term
;   command line = 'TERATERM myhost.mydomain' (telnet)
connect 'myhost.mydomain'

; set username
UsernamePrompt = 'Username:'
Username = 'MYNAME'
PasswordPrompt = 'Password:'
; get password from file
getpassword 'password.dat' 'mypassword' Password

; login
wait   UsernamePrompt
sendln Username

wait   PasswordPrompt
sendln Password

; OK, auto login complete.

; sample macro of Tera Term
; 
; File: ssh2login.ttl
; Description: auto login with SSH2 protocol
; Environment: generic

username = 'nike'
hostname = '192.168.1.3'

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

msg = 'Enter password for user '
strconcat msg username
passwordbox msg 'Get password'

msg = hostname
strconcat msg ':22 /ssh /auth=password /user='
strconcat msg username
strconcat msg ' /passwd='
strconcat msg inputstr

connect msg

Note

1. In these examples parameters shown with Italic font have to be replaced with their actual values.
2. The password can contain space character. To represent space inside the password replace it with '@' character. If '@' character itself is part of the password than it has to be replaced with 2 consecutive '@' characters '@@'.
3. Please remember that entering actual username and password in Tera Term macro will cause them to be stored as an open text and it is your responsibility to keep such macro is secure location.
4. When a user re-connect the remote host soon after disconnecting the server, a user could not connect the server. For more detail, refer to "here".

NEWS CONTENTS

• 210210 : Macro command connect syntax description ( Macro command 'connect' syntax description, )

Old News ;-)

Macro command 'connect' syntax description

Three types of connections
There are 3 types of connection you can establish from TeraTerm macro:

- Telnet connection (port 23)
- SSH1 or SSH2 connection (port 22)
- Connection via COM port

Telnet connections

Quote:

connect 'myserver:23 /nossh'

or

Quote:

connect 'myserver:23 /telnet'

or

Quote:

connect 'myserver:23'

Using /nossh is strongly recommended. Without this parameter TeraTerm will start connecting with the same method (telnet or SSH) that was used during last time when teraterm.ini file was saved. In case it was SSH than macro will try to connect via SSH and will eventually fail.

SSH connections

Quote:

connect 'myserver /ssh'

This way will start SSH connection without defining whether SSH1 or SSH2 has to be used.

Quote:

connect 'myserver /ssh /1'

or

Quote:

connect 'myserver /ssh /2'

Parameters /1 and /2 force to use SSH1 or SSH2 method.

Quote:

connect 'myserver /ssh /auth=password /user=username /passwd=password'

or

Quote:

connect 'myserver /ssh /1 /auth=password /user=username /passwd=password'

or

Quote:

connect 'myserver /ssh /2 /auth=password /user=username /passwd=password'

or

Quote:

connect 'myserver /ssh /auth=publickey /user=username /passwd=password /keyfile=private-key-file'

or

Quote:

connect 'myserver /ssh /1 /auth=publickey /user=username /passwd=password /keyfile=private-key-file'

or

Quote:

connect 'myserver /ssh /2 /auth=publickey /user=username /passwd=password /keyfile=private-key-file'

Above 6 ways allow to skip popup dialog and pass username and password directly from macro. Please note that /auth=password or /auth=publickey is the parameter saying that authentication will be done by entering password or private-key-file thus you should not replace the word 'password' or the word 'publickey' in it with actual values. Only the words shown above with italic font have to be substituted.

Important note: The password can contain space character. To represent space inside the password replace it with @ character. If @ character itself is part of the password than it has to be replaced with 2 consecutive @ characters @@.

Please remember that entering actual username and password in TeraTerm macro will cause them to be stored as an open text and it is your responsibility to keep such macros in secure place.

A little bit better practice is to use getpassword and passwordbox commands that store encrypted passwords in the file.

Quote:

connect 'myserver /ssh /auth=password /user=username /ask4passwd'

or

Quote:

connect 'myserver /ssh /1 /auth=password /user=username /ask4passwd'

or

Quote:

connect 'myserver /ssh /2 /auth=password /user=username /ask4passwd'

or

Quote:

connect 'myserver /ssh /auth=publickey /user=username /ask4passwd /keyfile=private-key-file'

or

Quote:

connect 'myserver /ssh /1 /auth=publickey /user=username /ask4passwd /keyfile=private-key-file'

or

Quote:

connect 'myserver /ssh /2 /auth=publickey /user=username /ask4passwd /keyfile=private-key-file'

Above 6 ways pass username and authentication method directly from macro, and the popup asks for password.

Connections via COM port

Quote:

connect '/C=x'

Here x represents COM port number. For example to connect via COM port 1 the command will look like: connect '/C=1'

About setsync
It is highly recommended to use the macro command

Quote:

setsync 1

right after the command connect. This command switches TeraTerm into synchronous communication mode in which the buffer never overflows. See TeraTerm Macro help for more details.
_________________
Thanks.
Best regards,
// Boris

Recommended Links

Softpanorama Recommended

Top articles

Sites

• MACRO Help Index - Tera Term Open Source Project
• How to run a macro file - Tera Term Open Source Project
• Teraterm Scripts - Texas Instruments Embedded Processors Wiki
• teraterm - Teraterm MACRO syntax highlighting - vim online

Etc

Society

Groupthink : Two Party System as Polyarchy : Corruption of Regulators : Bureaucracies : Understanding Micromanagers and Control Freaks : Toxic Managers :   Harvard Mafia : Diplomatic Communication : Surviving a Bad Performance Review : Insufficient Retirement Funds as Immanent Problem of Neoliberal Regime : PseudoScience : Who Rules America : Neoliberalism  : The Iron Law of Oligarchy : Libertarian Philosophy

Quotes

War and Peace : Skeptical Finance : John Kenneth Galbraith :Talleyrand : Oscar Wilde : Otto Von Bismarck : Keynes : George Carlin : Skeptics : Propaganda  : SE quotes : Language Design and Programming Quotes : Random IT-related quotes :  Somerset Maugham : Marcus Aurelius : Kurt Vonnegut : Eric Hoffer : Winston Churchill : Napoleon Bonaparte : Ambrose Bierce :  Bernard Shaw : Mark Twain Quotes

Bulletin:

Vol 25, No.12 (December, 2013) Rational Fools vs. Efficient Crooks The efficient markets hypothesis : Political Skeptic Bulletin, 2013 : Unemployment Bulletin, 2010 :  Vol 23, No.10 (October, 2011) An observation about corporate security departments : Slightly Skeptical Euromaydan Chronicles, June 2014 : Greenspan legacy bulletin, 2008 : Vol 25, No.10 (October, 2013) Cryptolocker Trojan (Win32/Crilock.A) : Vol 25, No.08 (August, 2013) Cloud providers as intelligence collection hubs : Financial Humor Bulletin, 2010 : Inequality Bulletin, 2009 : Financial Humor Bulletin, 2008 : Copyleft Problems Bulletin, 2004 : Financial Humor Bulletin, 2011 : Energy Bulletin, 2010 : Malware Protection Bulletin, 2010 : Vol 26, No.1 (January, 2013) Object-Oriented Cult : Political Skeptic Bulletin, 2011 : Vol 23, No.11 (November, 2011) Softpanorama classification of sysadmin horror stories : Vol 25, No.05 (May, 2013) Corporate bullshit as a communication method  : Vol 25, No.06 (June, 2013) A Note on the Relationship of Brooks Law and Conway Law

History:

Fifty glorious years (1950-2000): the triumph of the US computer engineering : Donald Knuth : TAoCP and its Influence of Computer Science : Richard Stallman : Linus Torvalds  : Larry Wall  : John K. Ousterhout : CTSS : Multix OS Unix History : Unix shell history : VI editor : History of pipes concept : Solaris : MS DOS :  Programming Languages History : PL/1 : Simula 67 : C : History of GCC development :  Scripting Languages : Perl history   : OS History : Mail : DNS : SSH : CPU Instruction Sets : SPARC systems 1987-2006 : Norton Commander : Norton Utilities : Norton Ghost : Frontpage history : Malware Defense History : GNU Screen : OSS early history

Classic books:

The Peter Principle : Parkinson Law : 1984 : The Mythical Man-Month :  How to Solve It by George Polya : The Art of Computer Programming : The Elements of Programming Style : The Unix Hater’s Handbook : The Jargon file : The True Believer : Programming Pearls : The Good Soldier Svejk : The Power Elite

Most popular humor pages:

Manifest of the Softpanorama IT Slacker Society : Ten Commandments of the IT Slackers Society : Computer Humor Collection : BSD Logo Story : The Cuckoo's Egg : IT Slang : C++ Humor : ARE YOU A BBS ADDICT? : The Perl Purity Test : Object oriented programmers of all nations : Financial Humor : Financial Humor Bulletin, 2008 : Financial Humor Bulletin, 2010 : The Most Comprehensive Collection of Editor-related Humor : Programming Language Humor : Goldman Sachs related humor : Greenspan humor : C Humor : Scripting Humor : Real Programmers Humor : Web Humor : GPL-related Humor : OFM Humor : Politically Incorrect Humor : IDS Humor : "Linux Sucks" Humor : Russian Musical Humor : Best Russian Programmer Humor : Microsoft plans to buy Catholic Church : Richard Stallman Related Humor : Admin Humor : Perl-related Humor : Linus Torvalds Related humor : PseudoScience Related Humor : Networking Humor : Shell Humor : Financial Humor Bulletin, 2011 : Financial Humor Bulletin, 2012 : Financial Humor Bulletin, 2013 : Java Humor : Software Engineering Humor : Sun Solaris Related Humor : Education Humor : IBM Humor : Assembler-related Humor : VIM Humor : Computer Viruses Humor : Bright tomorrow is rescheduled to a day after tomorrow : Classic Computer Humor

The Last but not Least Technology is dominated by two types of people: those who understand what they do not manage and those who manage what they do not understand ~Archibald Putt. Ph.D

The statements, views and opinions presented on this web page are those of the author (or referenced source) and are not endorsed by, nor do they necessarily reflect, the opinions of the Softpanorama society. We do not warrant the correctness of the information provided or its fitness for any purpose. The site uses AdSense so you need to be aware of Google privacy policy. You you do not want to be tracked by Google please disable Javascript for this site. This site is perfectly usable without Javascript.

Last modified: July 28, 2019