SSH Exec (Execute Command Line)

Shows how to execute a command on an SSH server and retrieve the command output.

Downloads:

MS Windows Visual C/C++ Libraries

Linux/CentOS C/C++ Libraries

MAC OS X C/C++ Libraries

Solaris C/C++ Libraries

C++ Builder Libraries

#include <C_CkSsh.h>

void ChilkatSample(void)
    {
    HCkSsh ssh;
    BOOL success;
    const char * hostname;
    long port;
    long channelNum;
    const char * cmd1;
    const char * cmd2;
    const char * cmd3;
    const char * cmd4;
    const char * cmd5;
    const char * cmd6;
    long n;
    long pollTimeoutMs;
    const char * cmdOutput;

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

    ssh = CkSsh_Create();

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

    success = CkSsh_UnlockComponent(ssh,"Anything for 30-day trial");
    if (success != TRUE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        return;
    }

    //  Connect to an SSH server:

    //  Hostname may be an IP address or hostname:
    hostname = "192.168.1.108";
    port = 22;

    success = CkSsh_Connect(ssh,hostname,port);
    if (success != TRUE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        return;
    }

    //  Wait a max of 5 seconds when reading responses..
    CkSsh_putIdleTimeoutMs(ssh,5000);

    //  Authenticate using login/password:
    success = CkSsh_AuthenticatePw(ssh,"myLogin","myPassword");
    if (success != TRUE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        return;
    }

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

    channelNum = CkSsh_OpenSessionChannel(ssh);
    if (channelNum < 0) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        return;
    }

    //  The SendReqExec method starts a command on the remote
    //  server.   The syntax of the command string depends on the
    //  default shell used on the remote server to run the command.
    //  On Windows systems it is CMD.EXE.  On UNIX/Linux
    //  systems the user's default shell is typically defined in /etc/password.

    //  Here are some examples of command lines for <b>Windows SSH servers</b>:

    //  Get a directory listing:

    cmd1 = "dir";

    //  Do a nameserver lookup:

    cmd2 = "nslookup chilkatsoft.com";

    //  List a specific directory.  Given that the shell is CMD.EXE, backslashes must
    //  be used:

    cmd3 = "dir \\temp";

    //  Execute a sequence of commands.  The syntax for CMD.EXE may be found
    //  here: http://technet.microsoft.com/en-us/library/bb490880.aspx.  Notice how the commands
    //  are separated by "&&" and the entire command must be enclosed in quotes:

    cmd4 = "\"cd \\temp&&dir\"";

    //  Here are two examples of command lines for <b>Linux/UNIX SSH servers</b>:

    //  Get a directory listing:

    cmd5 = "ls -l /tmp";

    //  Run a series of commands (syntax may depend on your default shell):

    cmd6 = "cd /etc; ls -la";

    //  Request a directory listing on the remote server:
    //  If your server is Windows, change the string from "ls" to "dir"
    success = CkSsh_SendReqExec(ssh,channelNum,"ls");
    if (success != TRUE) {
        printf("%s\n",CkSsh_lastErrorText(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 = CkSsh_ChannelReadAndPoll(ssh,channelNum,pollTimeoutMs);
    if (n < 0) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        return;
    }

    //  Close the channel:
    success = CkSsh_ChannelSendClose(ssh,channelNum);
    if (success != TRUE) {
        printf("%s\n",CkSsh_lastErrorText(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 = CkSsh_ChannelReceiveToClose(ssh,channelNum);
    if (success != TRUE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        return;
    }

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

    cmdOutput = CkSsh_getReceivedText(ssh,channelNum,"ansi");
    if (cmdOutput == 0 ) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        return;
    }

    //  Display the remote shell's command output:
    printf("%s\n",cmdOutput);

    //  Disconnect
    CkSsh_Disconnect(ssh);

    CkSsh_Dispose(ssh);

    }