Drush: commands/core/ssh.drush.inc File Reference

  1. 7.x doxygen/html/ssh_8drush_8inc.html
  2. master doxygen/html/ssh_8drush_8inc.html
ssh.drush.inc File Reference

Go to the source code of this file.

Functions

 ssh_drush_command ()
 drush_ssh_site_ssh ($command=NULL)

Detailed Description

The drush site-ssh command for connecting to a remote alias' server via SSH, either for an interactive session or to run a shell command.

Definition in file ssh.drush.inc.

Function Documentation

drush_ssh_site_ssh (   $command = NULL)

File

doxygen/html/ssh_8drush_8inc.html
View source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Drush: commands/core/ssh.drush.inc File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Drush
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_afac61274991793aa7e9133a8f4f291e.html">commands</a></li><li class="navelem"><a class="el" href="dir_5762b63965e3a68a35f77c23b4dd4668.html">core</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ssh.drush.inc File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a href="ssh_8drush_8inc_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a59a4a75a22082958e2bb6df30849e586"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59a4a75a22082958e2bb6df30849e586"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ssh_drush_command</b> ()</td></tr>
<tr class="memitem:a82a89cae3f9cd4bb76b6e9ac5bddb1cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ssh_8drush_8inc.html#a82a89cae3f9cd4bb76b6e9ac5bddb1cc">drush_ssh_site_ssh</a> ($command=NULL)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The drush site-ssh command for connecting to a remote alias' server via SSH, either for an interactive session or to run a shell command. </p>

<p>Definition in file <a class="el" href="ssh_8drush_8inc_source.html">ssh.drush.inc</a>.</p>
</div><h2>Function Documentation</h2>
<a class="anchor" id="a82a89cae3f9cd4bb76b6e9ac5bddb1cc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_ssh_site_ssh </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$command</em> = <code>NULL</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Command callback. </p>

<p>Definition at line <a class="el" href="ssh_8drush_8inc_source.html#l00035">35</a> of file <a class="el" href="ssh_8drush_8inc_source.html">ssh.drush.inc</a>.</p>

<p>References <a class="el" href="context_8inc_source.html#l00328">drush_get_context()</a>, <a class="el" href="context_8inc_source.html#l00405">drush_get_option()</a>, <a class="el" href="command_8inc_source.html#l01814">drush_get_original_cli_args_and_options()</a>, <a class="el" href="command_8inc_source.html#l00109">drush_invoke_process()</a>, <a class="el" href="context_8inc_source.html#l00293">drush_set_context()</a>, <a class="el" href="drush_8inc_source.html#l01525">drush_set_error()</a>, <a class="el" href="exec_8inc_source.html#l00196">drush_shell_proc_build()</a>, <a class="el" href="exec_8inc_source.html#l00240">drush_shell_proc_open()</a>, <a class="el" href="sitealias_8inc_source.html#l00211">drush_sitealias_get_record()</a>, <a class="el" href="sitealias_8inc_source.html#l01053">drush_sitealias_is_remote_site()</a>, and <a class="el" href="output_8inc_source.html#l00149">dt()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="ssh_8drush_8inc_a82a89cae3f9cd4bb76b6e9ac5bddb1cc_cgraph.png" border="0" usemap="#ssh_8drush_8inc_a82a89cae3f9cd4bb76b6e9ac5bddb1cc_cgraph" alt=""/></div>
<map name="ssh_8drush_8inc_a82a89cae3f9cd4bb76b6e9ac5bddb1cc_cgraph" id="ssh_8drush_8inc_a82a89cae3f9cd4bb76b6e9ac5bddb1cc_cgraph">
<area shape="rect" id="node3" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="1751,790,1879,819"/><area shape="rect" id="node5" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8" title="drush_get_option" alt="" coords="1341,1239,1461,1269"/><area shape="rect" id="node12" href="command_8inc.html#a272d98da256f7ae2988f3aa7cb6b464b" title="drush_get_original\l_cli_args_and_options" alt="" coords="1327,401,1476,448"/><area shape="rect" id="node22" href="group__dispatching.html#ga125471885af052278a0874446b332cf9" title="drush_invoke_process" alt="" coords="192,682,344,711"/><area shape="rect" id="node26" href="sitealias_8inc.html#ac2f57b80441374522c4e4cdc3b7e0c2b" title="drush_sitealias_get\l_record" alt="" coords="881,204,1015,251"/><area shape="rect" id="node62" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="929,654,967,683"/><area shape="rect" id="node113" href="group__commandwrappers.html#ga3a1bb3ae751f14749ce1dbe4ec9c3288" title="drush_shell_proc_open" alt="" coords="871,910,1025,939"/><area shape="rect" id="node118" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4" title="drush_set_error" alt="" coords="892,538,1004,567"/><area shape="rect" id="node125" href="context_8inc.html#af983acfe90e7d7bbdbd67c57f93708ba" title="drush_set_context" alt="" coords="204,1601,332,1630"/><area shape="rect" id="node129" href="group__commandwrappers.html#ga78a7ff5045fa4fc20c8e24dd2ba8d777" title="drush_shell_proc_build" alt="" coords="629,1446,784,1475"/><area shape="rect" id="node139" href="sitealias_8inc.html#a5437d4bdf307bcc37cd15e903b3d99a9" title="drush_sitealias_is\l_remote_site" alt="" coords="644,384,769,431"/><area shape="rect" id="node7" href="context_8inc.html#aee5781894bf828bfa508d9052553f809" title="_drush_get_option" alt="" coords="1541,1213,1669,1242"/><area shape="rect" id="node10" href="context_8inc.html#a9f6272c1a68141ce873c07aae3a316ac" title="drush_context_names" alt="" coords="1531,1266,1680,1295"/><area shape="rect" id="node15" href="context_8inc.html#a8fc57227375a540fea5314b154576354" title="drush_get_command" alt="" coords="1535,385,1676,414"/><area shape="rect" id="node18" href="group__dispatching.html#ga0edaf347ba975a7743a81eb3d7a4e38c" title="_drush_get_command\l_options" alt="" coords="1531,264,1680,311"/><area shape="rect" id="node20" href="command_8inc.html#a74995cc76034e90a39baee51111b20be" title="drush_command_invoke\l_all_ref" alt="" coords="1733,264,1896,311"/><area shape="rect" id="node24" href="sitealias_8inc.html#a0dd349885b59373b8a067d7589d096e7" title="drush_sitealias_resolve\l_sitespecs" alt="" coords="395,264,552,311"/><area shape="rect" id="node54" href="group__logging.html#ga47324b65808524558a488916b150dd51" title="drush_log" alt="" coords="1143,763,1220,793"/><area shape="rect" id="node68" href="sitealias_8inc.html#a0665329c1176b30398fa27ee5cd10423" title="drush_sitealias_simplify\l_names" alt="" coords="393,673,553,720"/><area shape="rect" id="node70" href="context_8inc.html#a559008f6decb23108b83e704208e415e" title="drush_get_option_override" alt="" coords="861,1118,1035,1147"/><area shape="rect" id="node75" href="backend_8inc.html#a7852d5448cd4ee3a2082eccd24d690e7" title="drush_backend_invoke\l_concurrent" alt="" coords="396,1032,551,1079"/><area shape="rect" id="node51" href="sitealias_8inc.html#a79d866a010f76b7d6ec47ab2a72a0c43" title="drush_sitealias_resolve\l_sitelist" alt="" coords="628,209,785,256"/><area shape="rect" id="node28" href="sitealias_8inc.html#a448de5768a772d33e44f86cfefe070ac" title="_drush_sitealias_get\l_record" alt="" coords="1111,204,1252,251"/><area shape="rect" id="node41" href="sitealias_8inc.html#a9e6067d5c022f5ee598fd0da886931a0" title="drush_sitealias_local\l_site_path" alt="" coords="1331,40,1472,87"/><area shape="rect" id="node43" href="sitealias_8inc.html#a7da9f5d71a8c274a8a1fc5d3889e9999" title="drush_sitealias_uri\l_to_site_dir" alt="" coords="1540,40,1671,87"/><area shape="rect" id="node47" href="sitealias_8inc.html#a3f06e1c033d491e01fe2841c08c0cd2e" title="drush_sitealias_lookup\l_alias_by_path" alt="" coords="1104,115,1259,161"/><area shape="rect" id="node31" href="group__filesystemfunctions.html#gafa80199035259ddf98fa300d6f646aa2" title="drush_is_absolute_path" alt="" coords="1527,161,1684,190"/><area shape="rect" id="node33" href="startup_8inc.html#a88114295372bcb0ca8dbb5f10b36368e" title="drush_is_windows" alt="" coords="1751,109,1879,138"/><area shape="rect" id="node36" href="sitealias_8inc.html#a6812218f7e86fa00ec5c011768c63f48" title="_drush_sitealias_set\l_record_element" alt="" coords="1331,211,1472,257"/><area shape="rect" id="node38" href="includes_2environment_8inc.html#adcda6d5e2415f63051b8cd4afde623b0" title="drush_valid_root" alt="" coords="1343,281,1460,310"/><area shape="rect" id="node56" href="group__logging.html#ga10110f5007bd6fd1b7915e9dece4774f" title="_drush_log" alt="" coords="1359,763,1444,793"/><area shape="rect" id="node59" href="backend_8inc.html#a38490210d77373f3d8492caf4e9a3190" title="drush_backend_packet" alt="" coords="1528,713,1683,742"/><area shape="rect" id="node64" href="drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="1115,640,1248,687"/><area shape="rect" id="node66" href="group__outputfunctions.html#ga2391425402626377e6464f1f649f8c65" title="find_legacy_dt_args" alt="" coords="1112,710,1251,739"/><area shape="rect" id="node72" href="context_8inc.html#add3af7aa09b1ccf49718577a8d7aa61d" title="drush_sitealias_get\l_option" alt="" coords="1115,1395,1248,1441"/><area shape="rect" id="node78" href="backend_8inc.html#a895f14d30af875ea1783a3de2355d095" title="_drush_backend_adjust\l_options" alt="" coords="628,963,785,1009"/><area shape="rect" id="node80" href="backend_8inc.html#aff4e2427168bc7585fcfa5eca6a94af0" title="_drush_backend_get\l_global_contexts" alt="" coords="1111,971,1252,1017"/><area shape="rect" id="node84" href="command_8inc.html#aed341ec21a59c794b73f7ba031825632" title="drush_command_get_command\l_specific_options" alt="" coords="604,1032,809,1079"/><area shape="rect" id="node86" href="backend_8inc.html#a20dd75d8a0d75a4e59db35c8918d1d8a" title="_drush_backend_classify\l_options" alt="" coords="623,1101,791,1148"/><area shape="rect" id="node89" href="group__commandwrappers.html#ga1292121e5bdd4bf19ef4f944b16301ed" title="drush_os" alt="" coords="911,1291,985,1321"/><area shape="rect" id="node92" href="startup_8inc.html#a80f9d7b288b6ae5fd2c7a8377f7d31b9" title="find_wrapper_or_launcher" alt="" coords="621,1171,792,1201"/><area shape="rect" id="node94" href="includes_2environment_8inc.html#ac03e907ca57149e27b2e34b186a65797" title="drush_build_drush_command" alt="" coords="1087,1041,1276,1070"/><area shape="rect" id="node98" href="backend_8inc.html#aa9bff3ffcd61a4dd945b567057a54e5d" title="_drush_backend_generate\l_command" alt="" coords="620,1325,793,1372"/><area shape="rect" id="node101" href="backend_8inc.html#ad19c067bfbd87dfc63c55659723aaf60" title="_drush_backend_argument\l_string" alt="" coords="859,1171,1037,1217"/><area shape="rect" id="node105" href="backend_8inc.html#a1d3f3caae7e1300c53e2cc1fe4ffb932" title="_drush_backend_invoke" alt="" coords="625,758,788,787"/><area shape="rect" id="node108" href="group__outputfunctions.html#ga63acbb94925d6d2693e235e966bba740" title="drush_print" alt="" coords="1139,918,1224,947"/><area shape="rect" id="node121" href="command_8inc.html#a19eba9666aba673a64fbd78a2c5ef4f9" title="drush_command_invoke_all" alt="" coords="1091,486,1272,515"/><area shape="rect" id="node131" href="group__commandwrappers.html#gae0975650ba125212c2666e58729f43cf" title="drush_remote_host" alt="" coords="881,1446,1015,1475"/></map>
</div>
</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 2 2016 07:29:22 for Drush by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>