ssh2_exec - PHP code example

PHP Function SSH2_EXEC

The php function ssh2_exec allows you to run a command at the remote end of a ssh connection. It is especially useful for long running programs that may require a lot of time to finish.

When executed, ssh2_exec sends a message to the server asking the remote user to execute an action. The ssh2_exec call then waits until the command is finished and then returns a result or an error code.

To use ssh2_exec, you must first install the SSH2 extension. This can be done via your Distro's repositories or by building it from PECL (though that is not recommended).

Once you have the ssh2_exec function in your script, you can call many of the other ssh2 functions like ssh2_connect(), ssh2_auth_password(), ssh2_sftp_recv(), ssh2_scp_send(), etc.

ssh2_connect() - (void) - Attempts to connect to a remote SSH2 server. If an authentication method is not specified in the config, it will try to authenticate with either a plain password or public key. If the config specifies an agent, it will try to connect to a UNIX socket for ssh-agent-based user authentication or, for Windows users, will attempt to connect to pageant.

ssh2_config() - (int) Sets the configuration of libssh2. Currently supported values are:

ssh2_exec example

    public function run_command( $command, $returnbool = false ) {
        if ( ! $this->link ) {
            return false;
        }

        $stream = ssh2_exec( $this->link, $command );

        if ( ! $stream ) {
            $this->errors->add(
                'command',
                sprintf(
                    /* translators: %s: Command. */
                    __( 'Unable to perform command: %s' ),
                    $command
                )
            );
        } else {

  protected function copyFileJailed($source, $destination) {
    if (!@ssh2_scp_send($this->connection, $source, $destination)) {
      throw new FileTransferException('Cannot copy @source_file to @destination_file.', 0, ['@source' => $source, '@destination' => $destination]);
    }
  }

  /** * {@inheritdoc} */
  protected function copyDirectoryJailed($source, $destination) {
    if (@!ssh2_exec($this->connection, 'cp -Rp ' . escapeshellarg($source) . ' ' . escapeshellarg($destination))) {
      throw new FileTransferException('Cannot copy directory @directory.', 0, ['@directory' => $source]);
    }
  }

  /** * {@inheritdoc} */
  protected function createDirectoryJailed($directory) {
    if (@!ssh2_exec($this->connection, 'mkdir ' . escapeshellarg($directory))) {
      throw new FileTransferException('Cannot create directory @directory.', 0, ['@directory' => $directory]);
    }
  }