Ruby

Get Text Received on the SSH stderr Buffer

Demonstrates the Chilkat Ssh.GetReceivedStderrText method, which decodes and returns the text accumulated in a channel's separate stderr buffer. The first argument is the channel number and the second is the charset. The stderr buffer is cleared after the text is returned.

Background: This is only meaningful when StderrToStdout is false, which keeps error output in its own buffer instead of merging it into the normal receive buffer. Separating the two lets a program parse a command's real output cleanly while still capturing diagnostics — important because many Unix tools write warnings to stderr that would otherwise corrupt the parsed result. With merging enabled, this buffer stays empty and the text appears via GetReceivedText instead.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Ssh.GetReceivedStderrText method, which decodes and returns the text in a
#  channel's separate stderr buffer.  The 1st argument is the channel number and the 2nd is the
#  charset.  The stderr buffer is cleared after the text is returned.

ssh = Chilkat::CkSsh.new()

sshPort = 22
success = ssh.Connect("ssh.example.com",sshPort)
if (success == false)
    print ssh.lastErrorText() + "\n";
    exit
end

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
password = "mySshPassword"

success = ssh.AuthenticatePw("mySshLogin",password)
if (success == false)
    print ssh.lastErrorText() + "\n";
    exit
end

#  Keep stderr in its own buffer rather than merging it into the normal receive buffer.
ssh.put_StderrToStdout(false)

channelNum = ssh.OpenSessionChannel()
if (channelNum < 0)
    print ssh.lastErrorText() + "\n";
    exit
end

#  Run a command that writes to both stdout and stderr.
success = ssh.SendReqExec(channelNum,"ls /etc/hosts /no/such/path")
if (success == false)
    print ssh.lastErrorText() + "\n";
    exit
end

#  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
#  it, this call waits forever if the server never sends channel close.
ssh.put_ReadTimeoutMs(15000)

success = ssh.ChannelReceiveToClose(channelNum)
if (success == false)
    print ssh.lastErrorText() + "\n";
    exit
end

stdoutText = ssh.getReceivedText(channelNum,"utf-8")
if (ssh.get_LastMethodSuccess() == false)
    print ssh.lastErrorText() + "\n";
    exit
end

print "STDOUT: " + stdoutText + "\n";

stderrText = ssh.getReceivedStderrText(channelNum,"utf-8")
if (ssh.get_LastMethodSuccess() == false)
    print ssh.lastErrorText() + "\n";
    exit
end

print "STDERR: " + stderrText + "\n";

ssh.Disconnect()