Java

Open an SSH Session Channel

Demonstrates the Chilkat Ssh.OpenSessionChannel method, which opens a new SSH session channel. It takes no arguments and returns the channel number, or -1 on failure. The transport must already be connected and authenticated.

Background: SSH multiplexes independent channels over one authenticated connection, and a session channel is the one used to run a command, start a shell, or invoke a subsystem. Opening the channel is only the container — nothing runs until you follow it with an exec, shell, or subsystem request. Always test for a negative return rather than assuming success.

Chilkat Java Downloads

Download Chilkat for Java

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Ssh;

public class ChilkatExample {

    public static void main(String[] args) {
        // Demonstrates the Ssh.OpenSessionChannel method, which opens a new SSH session channel.  It
        // takes no arguments and returns the channel number, or -1 on failure.  The transport must
        // already be connected and authenticated.

        Ssh ssh = new Ssh();

        int sshPort = 22;
        try {
            ssh.connect("ssh.example.com", sshPort);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // 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.
        String password = "mySshPassword";

        try {
            ssh.authenticatePw("mySshLogin", password);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Open a session channel.  A negative return value indicates failure.
        int channelNum = ssh.openSessionChannel();
        if (channelNum < 0) {
            System.out.println(ssh.getLastErrorText());
            return;
        }

        System.out.println("Opened session channel: " + channelNum);

        // Opening the channel does not start a shell or command -- send an exec, shell, or subsystem
        // request next.

        ssh.disconnect();
    }
}