diff --git a/tsshbatch.rst b/tsshbatch.rst index d743af4..dca08e2 100644 --- a/tsshbatch.rst +++ b/tsshbatch.rst @@ -1,28 +1,82 @@ NAME ---- -**tsshbatch** - Short Description +**tsshbatch** - Run Commands On Batches Of Machines SYNOPSIS -------- -tsshbatch.py [-hv] +tsshbatch.py [-hvk] [-n name] [-p pw] [-H 'h1 h2 ...' | serverlistfile] command arg ... + DESCRIPTION ----------- -Long description +``tsshbatch`` is a tool to enable you to issue a command to many +servers without having to log into each one separately. When writing +scripts, this overcomes the ``ssh`` limitation of not being able to +specify the password on the command line. + +``tsshbatch`` also understands basic ``sudo`` syntax and can be used +to access a server, ``sudo`` a command, and then exit. + +``tsshbatch`` thus allows you to write complex, hands-off scripts that +issue commands to many servers without the tedium of manual login and +``sudo`` promotion. System administrators, especially, will find this +helpful when working in large server farms. + OPTIONS ------- - -h Print help information. - -v Print detailed program version information and exit. + -h Print help information + -v Print detailed program version information and exit + -k Use ssh keys instead of name/password credentials + -n name Login name to use + -p pw Password to use when logging in and/or doing sudo + -H hostlist Single quoted list of hosts on which to run the command + + +ENVIRONMENT +----------- + +``tsshbatch`` respects the ``TSSHBATCH`` environment variable. You +may set this variable with any options above you commonly use to +avoid having to key them in each time you run the program. For +example:: + + export TSSHBATCH="-n jluser -p l00n3y" + +This would cause all subsequent invocations of ``tsshbatch`` to +attempt to use the login name/password credentials of ``jluser`` +and ``l00n3y`` respectively. + + +USE CASES +--------- + +1) Different Ways To Specify Targeted Hostnames + +2) Authentication Using Name And Password + + - Note security risk of plain text pw + +3) Authentication Using Key Exchange + +4) Executing A ``sudo`` Command + + - Forces luser to type in pw + + OTHER ----- You must have a reasonably current version of Python installed. +If your Python installation does not install ``paramiko`` you'll +have to install it manually, since ``tsshbatch`` requires these +libraries. + BUGS AND MISFEATURES -------------------- @@ -53,7 +107,7 @@ :: - $Id: tsshbatch.rst,v 1.100 2011/06/17 17:02:16 tundra Exp $ + $Id: tsshbatch.rst,v 1.101 2011/12/29 01:04:10 tundra Exp $ You can find the latest version of this program at: