<!DOCTYPE html>
<html>
<head>
  <meta http-equiv='content-type' value='text/html;charset=utf8'>
  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
  <title>knife-ssh(1) - Run a command or interactive session on multiple remote hosts</title>
  <style type='text/css' media='all'>
  /* style: man */
  body#manpage {margin:0}
  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
  .mp h2 {margin:10px 0 0 0}
  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
  .mp h3 {margin:0 0 0 4ex}
  .mp dt {margin:0;clear:left}
  .mp dt.flush {float:left;width:8ex}
  .mp dd {margin:0 0 0 9ex}
  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
  .mp pre {margin-bottom:20px}
  .mp pre+h2,.mp pre+h3 {margin-top:22px}
  .mp h2+pre,.mp h3+pre {margin-top:5px}
  .mp img {display:block;margin:auto}
  .mp h1.man-title {display:none}
  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
  .mp h2 {font-size:16px;line-height:1.25}
  .mp h1 {font-size:20px;line-height:2}
  .mp {text-align:justify;background:#fff}
  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
  .mp u {text-decoration:underline}
  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
  .mp b.man-ref {font-weight:normal;color:#434241}
  .mp pre {padding:0 4ex}
  .mp pre code {font-weight:normal;color:#434241}
  .mp h2+pre,h3+pre {padding-left:0}
  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
  ol.man-decor {width:100%}
  ol.man-decor li.tl {text-align:left}
  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
  ol.man-decor li.tr {text-align:right;float:right}
  </style>
  <style type='text/css' media='all'>
  /* style: toc */
  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
  .man-navigation a:hover {color:#111;text-decoration:underline}
  </style>
</head>
<!--
  The following styles are deprecated and will be removed at some point:
  div#man, div#man ol.man, div#man ol.head, div#man ol.man.

  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
  .man-navigation should be used instead.
-->
<body id='manpage'>
  <div class='mp' id='man'>

  <div class='man-navigation' style='display:none'>
    <a href="#NAME">NAME</a>
    <a href="#SYNOPSIS">SYNOPSIS</a>
    <a href="#DESCRIPTION">DESCRIPTION</a>
    <a href="#TERMINAL-MULTIPLEXING-AND-TERMINAL-TAB-SUPPORT">TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT</a>
    <a href="#SEE-ALSO">SEE ALSO</a>
    <a href="#AUTHOR">AUTHOR</a>
    <a href="#DOCUMENTATION">DOCUMENTATION</a>
    <a href="#CHEF">CHEF</a>
  </div>

  <ol class='man-decor man-head man head'>
    <li class='tl'>knife-ssh(1)</li>
    <li class='tc'>Chef Manual</li>
    <li class='tr'>knife-ssh(1)</li>
  </ol>

  <h2 id="NAME">NAME</h2>
<p class="man-name">
  <code>knife-ssh</code> - <span class="man-whatis">Run a command or interactive session on multiple remote hosts</span>
</p>

<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p><strong>knife</strong> <strong>ssh QUERY COMMAND</strong> <em>(options)</em></p>

<dl>
<dt><code>-a</code>, <code>--attribute ATTR      </code></dt><dd>The attribute to use for opening the connection - default is fqdn</dd>
<dt><code>-C</code>, <code>--concurrency NUM     </code></dt><dd>The number of concurrent connections</dd>
<dt><code>-m</code>, <code>--manual-list         </code></dt><dd>QUERY is a space separated list of servers</dd>
<dt><code>-P</code>, <code>--ssh-password PASSWORD</code></dt><dd>The ssh password</dd>
<dt><code>-x</code>, <code>--ssh-user USERNAME   </code></dt><dd>The ssh username</dd>
<dt><code>-i</code>, <code>--identity-file IDENTITY_FILE</code></dt><dd>The SSH identity file used for authentication</dd>
<dt><code>-p</code>, <code>--ssh-port PORT</code></dt><dd>The ssh port</dd>
<dt><code>--[no-]host-key-verify</code></dt><dd>Verify host key, enabled by default.</dd>
</dl>


<h2 id="DESCRIPTION">DESCRIPTION</h2>

<p>The <em>ssh</em> sub-command opens an ssh session to each of the nodes in the
search results of the <em>QUERY</em>. This sub-command requires that the
net-ssh-multi and highline Ruby libraries are installed. On Debian
systems, these are the libnet-ssh-multi-ruby and libhighline-ruby
packages. They can also be installed as RubyGems (net-ssh-multi and
highline, respectively).</p>

<h2 id="TERMINAL-MULTIPLEXING-AND-TERMINAL-TAB-SUPPORT">TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT</h2>

<p><code>knife ssh</code> integrates with several terminal multiplexer programs to
provide a more convenient means of managing multiple ssh sessions. When
the <em>COMMAND</em> option matches one of these, <code>knife ssh</code> will create
multiple interactive ssh sessions running locally in the terminal
multiplexer instead of invoking the command on the remote host.</p>

<p>The available multiplexers are:</p>

<dl>
<dt><code>interactive</code></dt><dd>A built-in multiplexer. <code>interactive</code> supports running commands on a
subset of the connected hosts in parallel</dd>
<dt><strong>screen</strong>(1)</dt><dd>Runs ssh interactively inside <code>screen</code>. ~/.screenrc will be sourced
if it exists.</dd>
<dt class="flush"><strong>tmux</strong>(1)</dt><dd>Runs ssh interactively inside tmux.</dd>
<dt><code>macterm</code> (Mac OS X only)</dt><dd>Opens a Terminal.app window and creates a tab for each ssh session.
You must install the rb-appscript gem before you can use this
option.</dd>
</dl>


<h2 id="SEE-ALSO">SEE ALSO</h2>

<p>   <strong>knife-search</strong>(1)</p>

<h2 id="AUTHOR">AUTHOR</h2>

<p>   Chef was written by Adam Jacob <a href="&#x6d;&#97;&#x69;&#x6c;&#x74;&#x6f;&#58;&#x61;&#100;&#x61;&#109;&#x40;&#x6f;&#x70;&#x73;&#99;&#x6f;&#100;&#101;&#x2e;&#99;&#x6f;&#x6d;" data-bare-link="true">&#97;&#100;&#97;&#x6d;&#64;&#111;&#112;&#115;&#x63;&#111;&#100;&#x65;&#x2e;&#x63;&#x6f;&#109;</a> with many contributions from the community.</p>

<h2 id="DOCUMENTATION">DOCUMENTATION</h2>

<p>   This manual page was written by Joshua Timberman <a href="&#x6d;&#97;&#105;&#108;&#x74;&#x6f;&#58;&#x6a;&#x6f;&#115;&#x68;&#117;&#97;&#64;&#111;&#112;&#x73;&#99;&#x6f;&#x64;&#101;&#x2e;&#99;&#x6f;&#x6d;" data-bare-link="true">&#106;&#111;&#115;&#x68;&#x75;&#x61;&#x40;&#x6f;&#x70;&#x73;&#99;&#x6f;&#x64;&#x65;&#46;&#x63;&#x6f;&#109;</a>.
   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>

<h2 id="CHEF">CHEF</h2>

<p>   Knife is distributed with Chef. <a href="http://wiki.opscode.com/display/chef/Home" data-bare-link="true">http://wiki.opscode.com/display/chef/Home</a></p>


  <ol class='man-decor man-foot man foot'>
    <li class='tl'>Chef 11.8.2.rc.0</li>
    <li class='tc'>November 2013</li>
    <li class='tr'>knife-ssh(1)</li>
  </ol>

  </div>
</body>
</html>