SSH2_EXEC(3) 1 SSH2_EXEC(3)
ssh2_exec - Execute a command on a remote server
SYNOPSIS
resource ssh2_exec (resource $session, string $command, [string $pty], [array $env], [int $width = 80], [int $height = 25], [int
$width_height_type = SSH2_TERM_UNIT_CHARS])
DESCRIPTION
Execute a command at the remote end and allocate a channel for it.
PARAMETERS
o $session
- An SSH connection link identifier, obtained from a call to ssh2_connect(3).
o $command
-
o $pty
-
o $env
-$env may be passed as an associative array of name/value pairs to set in the target environment.
o $width
- Width of the virtual terminal.
o $height
- Height of the virtual terminal.
o $width_height_type
-$width_height_type should be one of SSH2_TERM_UNIT_CHARS or SSH2_TERM_UNIT_PIXELS.
RETURN VALUES
Returns a stream on success or FALSE on failure.
EXAMPLES
Example #1
Executing a command
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$stream = ssh2_exec($connection, '/usr/local/bin/php -i');
?>
SEE ALSO
ssh2_connect(3), ssh2_shell(3), ssh2_tunnel(3).
PHP Documentation Group SSH2_EXEC(3)
