How to use the Client function from ssh2

ssh2.Client is a Node.js module that provides an SSH client implementation for establishing secure shell connections to remote servers.

How does ssh2.Client work?

ssh2.Client is a module in Node.js that provides an easy-to-use interface for establishing SSH connections and executing commands on a remote server. It works by creating an SSH client instance that can be configured with connection options and event listeners. Once connected, you can execute commands and transfer files to and from the remote server. The module also supports advanced features such as agent forwarding, tunneling, and compression.

Ai Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const Client = require("ssh2").Client;

const conn = new Client();

conn
  .on("ready", function () {
    console.log("Client :: ready");
    conn.exec("uptime", function (err, stream) {
      if (err) throw err;
      stream
        .on("close", function (code, signal) {
          console.log(
            "Stream :: close :: code: " + code + ", signal: " + signal
          );
          conn.end();
        })
        .on("data", function (data) {
          console.log("STDOUT: " + data);
        })
        .stderr.on("data", function (data) {
          console.log("STDERR: " + data);
        });
    });
  })
  .connect({
    host: "example.com",
    port: 22,
    username: "username",
    privateKey: require("fs").readFileSync("/home/username/.ssh/id_rsa"),
  });

In this example, we create a new ssh2.Client object and connect to an SSH server with the provided credentials. Once the connection is established, we use the exec method to execute the uptime command on the server. We then listen for events on the resulting stream object to capture the output of the command. When the command finishes, we close the connection with conn.end().