libssh2_channel_process_startup(3)

libssh2_channel_process_startup3

Request a shell on a channel

Usage

#include <libssh2.h>
int
libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel,
                                const char *request,
                                unsigned int request_len,
                                const char *message,
                                unsigned int message_len);

Overview

channel - Active session channel instance.

request - Type of process to startup. The SSH2 protocol currently defines shell, exec, and subsystem as standard process services.

request_len - Length of request parameter.

message - Request specific message data to include.

message_len - Length of message parameter.

Initiate a request on a session type channel such as returned by libssh2_channel_open_ex(3)

Return value

Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.

Errors

LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.

LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED -

Releases

10 releases since Debian 5.0 (Lenny); the text changed 3 times.

  1. 5.0
  2. 6.0
  3. 7–12
  4. 13–Arch

From libssh2 1.11.1-7 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.