<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Request an interactive shell</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-sftp.html">ssh2_sftp</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-tunnel.html">ssh2_tunnel</a></div>
<div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ssh2-shell" class="refentry">
<div class="refnamediv">
<h1 class="refname">ssh2_shell</h1>
<p class="verinfo">(PECL ssh2 >= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_shell</span> — <span class="dc-title">Request an interactive shell</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ssh2-shell-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>ssh2_shell</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$session</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$term_type</code><span class="initializer"> = "vanilla"</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$env</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code><span class="initializer"> = 80</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$height</code><span class="initializer"> = 25</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width_height_type</code><span class="initializer"> = SSH2_TERM_UNIT_CHARS</span></span>
]]]]] )</div>
<p class="para rdfs-comment">
Open a shell at the remote end and allocate a stream for it.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ssh2-shell-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">session</code></em></span>
<dd>
<p class="para">
An SSH connection link identifier, obtained from a call to
<span class="function"><a href="function.ssh2-connect.html" class="function">ssh2_connect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">term_type</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">term_type</code></em> should correspond to one of the
entries in the target system's <em>/etc/termcap</em> file.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">env</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">env</code></em> may be passed as an associative array of
name/value pairs to set in the target environment.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">width</code></em></span>
<dd>
<p class="para">
Width of the virtual terminal.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">height</code></em></span>
<dd>
<p class="para">
Height of the virtual terminal.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">width_height_type</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">width_height_type</code></em> should be one of
<strong><code>SSH2_TERM_UNIT_CHARS</code></strong> or
<strong><code>SSH2_TERM_UNIT_PIXELS</code></strong>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ssh2-shell-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ssh2-shell-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4630">
<p><strong>Example #1 Executing a command</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$connection </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'shell.example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ssh2_auth_password</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'password'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$stream </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_shell</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #DD0000">'vt102'</span><span style="color: #007700">, </span><span style="color: #0000BB">null</span><span style="color: #007700">, </span><span style="color: #0000BB">80</span><span style="color: #007700">, </span><span style="color: #0000BB">24</span><span style="color: #007700">, </span><span style="color: #0000BB">SSH2_TERM_UNIT_CHARS</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ssh2-shell-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ssh2-exec.html" class="function" rel="rdfs-seeAlso">ssh2_exec()</a> - Execute a command on a remote server</span></li>
<li class="member"> <span class="function"><a href="function.ssh2-tunnel.html" class="function" rel="rdfs-seeAlso">ssh2_tunnel()</a> - Open a tunnel through a remote server</span></li>
<li class="member"> <span class="function"><a href="function.ssh2-fetch-stream.html" class="function" rel="rdfs-seeAlso">ssh2_fetch_stream()</a> - Fetch an extended data stream</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-sftp.html">ssh2_sftp</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-tunnel.html">ssh2_tunnel</a></div>
<div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
