ssh2_shell
(PECL ssh2 >= 0.9.0)
ssh2_shell — Request an interactive shell
Description
resource
$session,string
$term_type = "vanilla",?array
$env = null,int
$width = 80,int
$height = 25,int
$width_height_type = SSH2_TERM_UNIT_CHARS): resource|false
Open a shell at the remote end and allocate a stream for it.
Parameters
-
session -
An SSH connection link identifier, obtained from a call to ssh2_connect().
-
term_type -
term_typeshould correspond to one of the entries in the target system's/etc/termcapfile. -
env -
envmay 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_typeshould be one ofSSH2_TERM_UNIT_CHARSorSSH2_TERM_UNIT_PIXELS.
Return Values
Returns a stream resource on success, or false on failure.
Examples
Example #1 Requesting an interactive shell
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$stream = ssh2_shell($connection, 'vt102', null, 80, 24, SSH2_TERM_UNIT_CHARS);
?>
See Also
- ssh2_exec() - Execute a command on a remote server
- ssh2_tunnel() - Open a tunnel through a remote server
- ssh2_fetch_stream() - Fetch an extended data stream
