Multiple SendReqExec on Same Connection

Shows how to execute a series of commands on an SSH server and retrieve each command's output (using SendReqExec). Each call to SendReqExec requires its own logical session channel. This is not a separate TCP/IP connection -- it's simply a new session channel on the existing connection. The sequence of Chilkat SSH calls would look like this:

Connect
AuthenticatePw (or AuthenticatePk)

OpenSessionChannel
SendReqExec
<retrieve command output...>
SendChannelClose
ChannelReceiveToClose (to make sure all remaining output is received)

OpenSessionChannel
SendReqExec
<retrieve command output...>
SendChannelClose
ChannelReceiveToClose (to make sure all remaining output is received)

...

OpenSessionChannel
SendReqExec
<retrieve command output...>
SendChannelClose
ChannelReceiveToClose (to make sure all remaining output is received)

Disconnect

Download Chilkat 32-bit SSH / SFTP ActiveX (.msi)

Download All 32-bit Chilkat ActiveX Components (.zip)

Download All 64-bit Chilkat ActiveX Components (.zip)

LOCAL loSsh
LOCAL lnSuccess
LOCAL lcHostname
LOCAL lnPort
LOCAL lnChannelNum
LOCAL lcCmd
LOCAL n
LOCAL lnPollTimeoutMs
LOCAL lcCmdOutput

*  Important: It is helpful to send the contents of the
*  ssh.LastErrorText property when requesting support.

loSsh = CreateObject('Chilkat.Ssh')

*  Any string automatically begins a fully-functional 30-day trial.

lnSuccess = loSsh.UnlockComponent("Anything for 30-day trial")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Connect to an SSH server:

*  Hostname may be an IP address or hostname:
lcHostname = "192.168.1.108"
lnPort = 22

lnSuccess = loSsh.Connect(lcHostname,lnPort)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Wait a max of 5 seconds when reading responses..
loSsh.IdleTimeoutMs = 5000

*  Authenticate using login/password:
lnSuccess = loSsh.AuthenticatePw("myLogin","myPassword")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Open a session channel.  (It is possible to have multiple
*  session channels open simultaneously.)

lnChannelNum = loSsh.OpenSessionChannel()
IF (lnChannelNum < 0) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Request a directory listing on the remote server:
*  If your server is Linux/UNIX, change the string from "dir" to "ls"
*  Note: Some SSH servers require a CRLF instead of a bare-LF

lcCmd = "ls -al" + Undefined variable: lf
lnSuccess = loSsh.SendReqExec(lnChannelNum,lcCmd)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Read whatever output may already be available on the
*  SSH connection.  ChannelReadAndPoll returns the number of bytes
*  that are available in the channel's internal buffer that
*  are ready to be "picked up" by calling GetReceivedText
*  or GetReceivedData.
*  A return value of -1 indicates failure.
*  A return value of -2 indicates a failure via timeout.

*  The ChannelReadAndPoll method waits
*  for data to arrive on the connection usingi the IdleTimeoutMs
*  property setting.  Once the first data arrives, it continues
*  reading but instead uses the pollTimeoutMs passed in the 2nd argument:
*  A return value of -2 indicates a timeout where no data is received.

lnPollTimeoutMs = 2000
n = loSsh.ChannelReadAndPoll(lnChannelNum,lnPollTimeoutMs)
IF (n < 0) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Close the channel:
lnSuccess = loSsh.ChannelSendClose(lnChannelNum)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Perhaps we did not receive all of the commands output.
*  To make sure,  call ChannelReceiveToClose to accumulate any remaining
*  output until the server's corresponding "channel close" is received.
lnSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Let's pickup the accumulated output of the command:

lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"ansi")
IF (lcCmdOutput = NULL ) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Display the remote shell's command output:
? lcCmdOutput
? "----"

*  -----------------------------------------------------------------
*  Now for the 2nd SendReqExe (on the same connection,
*  but on a separate logical channel).
*  -----------------------------------------------------------------

lnChannelNum = loSsh.OpenSessionChannel()
IF (lnChannelNum < 0) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

lcCmd = "nslookup chilkatsoft.com" + Undefined variable: lf
lnSuccess = loSsh.SendReqExec(lnChannelNum,lcCmd)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

lnPollTimeoutMs = 2000
n = loSsh.ChannelReadAndPoll(lnChannelNum,lnPollTimeoutMs)
IF (n < 0) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

lnSuccess = loSsh.ChannelSendClose(lnChannelNum)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

lnSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"ansi")
IF (lcCmdOutput = NULL ) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

? lcCmdOutput

*  Disconnect
loSsh.Disconnect()