Unicode C
Unicode C
SSH Remote Shell Multiple Commands
See more SSH Examples
Demonstrates how to start a shell on a remote SSH server, run a command, and retrieve the output, then run the next command, retrieve the output, etc.Chilkat Unicode C Downloads
#include <C_CkSshW.h>
void ChilkatSample(void)
{
BOOL success;
HCkSshW ssh;
const wchar_t *myPrompt;
const wchar_t *cmdOutput;
const wchar_t *hostname;
int port;
int channelNum;
const wchar_t *termType;
int widthInChars;
int heightInChars;
int pixWidth;
int pixHeight;
int n;
int pollTimeoutMs;
success = FALSE;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
ssh = CkSshW_Create();
// This is the prompt we'll be expecting to find in
// the output of the remote shell.
myPrompt = L"chilkat@ubuntu:~/workspace$";
// Connect to an SSH server:
// Hostname may be an IP address or hostname:
hostname = L"www.some-ssh-server.com";
port = 22;
success = CkSshW_Connect(ssh,hostname,port);
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Wait a max of 10 seconds when reading responses..
CkSshW_putIdleTimeoutMs(ssh,10000);
// Authenticate using login/password:
success = CkSshW_AuthenticatePw(ssh,L"myLogin",L"myPassword");
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Open a session channel. (It is possible to have multiple
// session channels open simultaneously.)
channelNum = CkSshW_OpenSessionChannel(ssh);
if (channelNum < 0) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
termType = L"dumb";
widthInChars = 120;
heightInChars = 40;
// Use 0 for pixWidth and pixHeight when the dimensions
// are set in number-of-chars.
pixWidth = 0;
pixHeight = 0;
success = CkSshW_SendReqPty(ssh,channelNum,termType,widthInChars,heightInChars,pixWidth,pixHeight);
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Start a shell on the channel:
success = CkSshW_SendReqShell(ssh,channelNum);
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Run the 1st command in the remote shell, which will be to
// "cd" to a subdirectory.
success = CkSshW_ChannelSendString(ssh,channelNum,L"cd workspace\r\n",L"ansi");
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Retrieve the output.
success = CkSshW_ChannelReceiveUntilMatch(ssh,channelNum,myPrompt,L"ansi",TRUE);
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Display what we've received so far. This clears
// the internal receive buffer, which is important.
// After we send the command, we'll be reading until
// the next command prompt. If the command prompt
// is already in the internal receive buffer, it'll think it's
// already finished...
cmdOutput = CkSshW_getReceivedText(ssh,channelNum,L"ansi");
if (CkSshW_getLastMethodSuccess(ssh) != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
wprintf(L"%s\n",cmdOutput);
// Run the 2nd command in the remote shell, which will be
// to "ls" the directory.
success = CkSshW_ChannelSendString(ssh,channelNum,L"ls\r\n",L"ansi");
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Retrieve and display the output.
success = CkSshW_ChannelReceiveUntilMatch(ssh,channelNum,myPrompt,L"ansi",TRUE);
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
cmdOutput = CkSshW_getReceivedText(ssh,channelNum,L"ansi");
if (CkSshW_getLastMethodSuccess(ssh) != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
wprintf(L"%s\n",cmdOutput);
// Start the final command in the remote shell. This example
// will send a "ls -l" command to retrieve the long format directory listing.
success = CkSshW_ChannelSendString(ssh,channelNum,L"ls -l\r\n",L"ansi");
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Send an EOF. This tells the server that no more data will
// be sent on this channel. The channel remains open, and
// the SSH client may still receive output on this channel.
success = CkSshW_ChannelSendEof(ssh,channelNum);
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// 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.
pollTimeoutMs = 2000;
n = CkSshW_ChannelReadAndPoll(ssh,channelNum,pollTimeoutMs);
if (n < 0) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// Close the channel:
success = CkSshW_ChannelSendClose(ssh,channelNum);
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
// 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.
success = CkSshW_ChannelReceiveToClose(ssh,channelNum);
if (success != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
cmdOutput = CkSshW_getReceivedText(ssh,channelNum,L"ansi");
if (CkSshW_getLastMethodSuccess(ssh) != TRUE) {
wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
CkSshW_Dispose(ssh);
return;
}
wprintf(L"%s\n",cmdOutput);
// Disconnect
CkSshW_Disconnect(ssh);
CkSshW_Dispose(ssh);
}