Home > PHP > Function > SSH2 > ssh2_shell()

ssh2_shell()

ssh2_shell - Request an interactive shell

Syntax

resource ssh2_shell (resource $session, string $term_type, array $env, int $width, int $height, int $width_height_type)

Arguments

  • session - An SSH connection link identifier, obtained from a call to ssh2_connect().
  • term_type - term_type should correspond to one of the entries in the target system\'s /etc/termcapfile.
  • env - env may be passed as an associative array of name/value pairs to set in the target environment.
  • width - Width of the virtual terminal.
  • height - Height of the virtual terminal.
  • width_height_type - width_height_type should be one of SSH2_TERM_UNIT_CHARS or SSH2_TERM_UNIT_PIXELS.

Description

Open a shell at the remote end and allocate a stream for it.

Version

PHP PECL ssh2 >= 0.9.0

Return value