.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "KNIFE\-SSH" "1" "January 2013" "Chef 10.18.0.rc.2" "Chef Manual"
.
.SH "NAME"
\fBknife\-ssh\fR \- Run a command or interactive session on multiple remote hosts
.
.SH "SYNOPSIS"
\fBknife\fR \fBssh QUERY COMMAND\fR \fI(options)\fR
.
.TP
\fB\-a\fR, \fB\-\-attribute ATTR\fR
The attribute to use for opening the connection \- default is fqdn
.
.TP
\fB\-C\fR, \fB\-\-concurrency NUM\fR
The number of concurrent connections
.
.TP
\fB\-m\fR, \fB\-\-manual\-list\fR
QUERY is a space separated list of servers
.
.TP
\fB\-P\fR, \fB\-\-ssh\-password PASSWORD\fR
The ssh password
.
.TP
\fB\-x\fR, \fB\-\-ssh\-user USERNAME\fR
The ssh username
.
.TP
\fB\-i\fR, \fB\-\-identity\-file IDENTITY_FILE\fR
The SSH identity file used for authentication
.
.TP
\fB\-p\fR, \fB\-\-ssh\-port PORT\fR
The ssh port
.
.TP
\fB\-\-[no\-]host\-key\-verify\fR
Verify host key, enabled by default\.
.
.SH "DESCRIPTION"
The \fIssh\fR sub\-command opens an ssh session to each of the nodes in the search results of the \fIQUERY\fR\. 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)\.
.
.SH "TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT"
\fBknife ssh\fR integrates with several terminal multiplexer programs to provide a more convenient means of managing multiple ssh sessions\. When the \fICOMMAND\fR option matches one of these, \fBknife ssh\fR will create multiple interactive ssh sessions running locally in the terminal multiplexer instead of invoking the command on the remote host\.
.
.P
The available multiplexers are:
.
.TP
\fBinteractive\fR
A built\-in multiplexer\. \fBinteractive\fR supports running commands on a subset of the connected hosts in parallel
.
.TP
\fBscreen\fR(1)
Runs ssh interactively inside \fBscreen\fR\. ~/\.screenrc will be sourced if it exists\.
.
.TP
\fBtmux\fR(1)
Runs ssh interactively inside tmux\.
.
.TP
\fBmacterm\fR (Mac OS X only)
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\.
.
.SH "SEE ALSO"
\fBknife\-search\fR(1)
.
.SH "AUTHOR"
Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
.
.SH "DOCUMENTATION"
This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
.
.SH "CHEF"
Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR