diff --git a/tsshbatch.rst b/tsshbatch.rst index dca08e2..9c26b36 100644 --- a/tsshbatch.rst +++ b/tsshbatch.rst @@ -41,15 +41,14 @@ ----------- ``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:: +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. +attempt to use the login name/password credentials of ``jluser`` and +``l00n3y`` respectively. USE CASES @@ -57,9 +56,43 @@ 1) Different Ways To Specify Targeted Hostnames + There are two ways to specify the list of servers on which you want + to run the specified command: + + - On the command line via the ``-H`` option:: + + tsshbatch.py -H 'hostA hostB' uname -a + + This would run the command ``uname -`` on the + hosts ``hostA`` and ``hostB`` respectively. + + Notice that the list of hosts must be separated by spaces but + passed as a *single argument*. Hence we enclose them in single + quotes. + + - Via a host list file:: + + tsshbatch.py myhosts df -Ph + + Here, ``tsshbatch`` expects the file ``myhosts`` to contain a + list of hosts, one per line, on which to run the command ``df + -Ph``. As an example, if you want to target the hosts ``larry``, + ``curly`` and ``moe`` in ``foo.com``, ``myhosts`` would look + like this:: + + larry.foo.com + curly.foo.com + moe.foo.com + + This method is handy when there are standard "sets" of servers + on which you regularly work. For instance, you may wish to + keep a host file lis for each of your production servers, each + of your test servers, each of your AIX servers, and so on. + + 2) Authentication Using Name And Password - - Note security risk of plain text pw + 3) Authentication Using Key Exchange @@ -72,10 +105,9 @@ 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. +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 @@ -83,6 +115,7 @@ None known as of this release. + COPYRIGHT AND LICENSING ----------------------- @@ -93,6 +126,7 @@ system using the 'ports' mechanism, you will also find this file in ``/usr/local/share/doc/tsshbatch``. + AUTHOR ------ @@ -107,7 +141,7 @@ :: - $Id: tsshbatch.rst,v 1.101 2011/12/29 01:04:10 tundra Exp $ + $Id: tsshbatch.rst,v 1.102 2011/12/30 16:53:02 tundra Exp $ You can find the latest version of this program at: