(SQL Server) 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 channel. This is not a separate SSH connection -- it's simply a new session channel on the existing SSH connection.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

// Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
//
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @ssh int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Ssh', @ssh OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Hostname may be an IP address or domain:
    DECLARE @hostname nvarchar(4000)
    SELECT @hostname = '172.16.16.46'
    DECLARE @port int
    SELECT @port = 22

    DECLARE @success int
    EXEC sp_OAMethod @ssh, 'Connect', @success OUT, @hostname, @port
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- If receiving output from a command stalls for more than 5 seconds, then stop waiting.
    EXEC sp_OASetProperty @ssh, 'IdleTimeoutMs', 5000

    -- Authenticate using login/password:
    EXEC sp_OAMethod @ssh, 'AuthenticatePw', @success OUT, 'myLogin', 'myPassword'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- Open a session channel.  (It is possible to have multiple
    -- session channels open simultaneously.)
    DECLARE @channelNum int
    EXEC sp_OAMethod @ssh, 'OpenSessionChannel', @channelNum OUT
    IF @channelNum < 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- 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
    DECLARE @cmd nvarchar(4000)
    SELECT @cmd = 'ls -al' + CHAR(10)
    EXEC sp_OAMethod @ssh, 'SendReqExec', @success OUT, @channelNum, @cmd
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- 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.
    DECLARE @pollTimeoutMs int
    SELECT @pollTimeoutMs = 2000
    DECLARE @n int
    EXEC sp_OAMethod @ssh, 'ChannelReadAndPoll', @n OUT, @channelNum, @pollTimeoutMs
    IF @n < 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- Close the channel:
    EXEC sp_OAMethod @ssh, 'ChannelSendClose', @success OUT, @channelNum
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- 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.
    EXEC sp_OAMethod @ssh, 'ChannelReceiveToClose', @success OUT, @channelNum
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- Get the accumulated output of the command:
    DECLARE @cmdOutput nvarchar(4000)

    EXEC sp_OAMethod @ssh, 'GetReceivedText', @cmdOutput OUT, @channelNum, 'ansi'
    EXEC sp_OAGetProperty @ssh, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- Display the remote shell's command output:

    PRINT @cmdOutput

    PRINT '----'

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

    EXEC sp_OAMethod @ssh, 'OpenSessionChannel', @channelNum OUT
    IF @channelNum < 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    SELECT @cmd = 'nslookup chilkatsoft.com' + CHAR(10)
    EXEC sp_OAMethod @ssh, 'SendReqExec', @success OUT, @channelNum, @cmd
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    SELECT @pollTimeoutMs = 2000
    EXEC sp_OAMethod @ssh, 'ChannelReadAndPoll', @n OUT, @channelNum, @pollTimeoutMs
    IF @n < 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    EXEC sp_OAMethod @ssh, 'ChannelSendClose', @success OUT, @channelNum
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    EXEC sp_OAMethod @ssh, 'ChannelReceiveToClose', @success OUT, @channelNum
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    EXEC sp_OAMethod @ssh, 'GetReceivedText', @cmdOutput OUT, @channelNum, 'ansi'
    EXEC sp_OAGetProperty @ssh, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END


    PRINT @cmdOutput

    EXEC @hr = sp_OADestroy @ssh


END
GO