ssh2_shell
(PECL ssh2 >= 0.9.0)
ssh2_shell — Request an interactive shell
Description
$session
[, string $term_type
= "vanilla"
[, array $env
[, int $width
= 80
[, int $height
= 25
[, int $width_height_type
= SSH2_TERM_UNIT_CHARS
]]]]] ) : resourceOpen 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_type
should correspond to one of the entries in the target system's /etc/termcap file. -
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 ofSSH2_TERM_UNIT_CHARS
orSSH2_TERM_UNIT_PIXELS
.
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
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-ssh2-shell.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.