ssh2_shell
PECL ssh2 >= 0.9.0
ssh2_shell - Request an interactive shell
Manual
ssh2_shell(
resource$session,
[string$term_type = "vanilla"],
[array|null$env = null],
[int$width = 80],
[int$height = 25],
[int$width_height_type = SSH2_TERM_UNIT_CHARS]
): resource|false
resource$session,
[string$term_type = "vanilla"],
[array|null$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_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 of SSH2_TERM_UNIT_CHARS or SSH2_TERM_UNIT_PIXELS.
Return Values
Returns a stream resource on success, or false on failure.