diff --git a/tsshbatch.rst b/tsshbatch.rst index 2cc407d..6af4edf 100644 --- a/tsshbatch.rst +++ b/tsshbatch.rst @@ -8,7 +8,7 @@ SYNOPSIS -------- -tsshbatch.py [-NSehkv -G 'file dest' -P 'file dest' -f file -n name -p pw ] -H 'host ..' | serverlistfile [command arg ... ] +tsshbatch.py [-NSehkv -G 'file dest' -P 'file dest' -f file -n name -p pw ] -H 'host ..' | hostlistfile [command arg ... ] DESCRIPTION @@ -28,7 +28,7 @@ ``tsshbatch`` thus allows you to write complex, hands-off scripts that issue commands to many hosts without the tedium of manual login and ``sudo`` promotion. System administrators, especially, will find this -helpful when working in large host farms. +helpful when working in large server farms. OPTIONS @@ -40,7 +40,7 @@ -G spec GET file on host and write local dest directory. ``spec`` is a quoted pair of strings. The first - secifies the path of the source file (on the + specifies the path of the source file (on the remote machine) to copy. The second, specifies the destination *directory* (on the local machine):: @@ -64,7 +64,7 @@ -P spec PUT file from local machine to remote machine destination directory. ``spec`` is a quoted pair of strings. - The first secifies the path of the source file (on + The first specifies the path of the source file (on the local machine) to copy. The second, specifies the destination *directory* (on the remote machine):: @@ -77,8 +77,8 @@ -e Don't report remote host stderr output - -f file Read commands from a file. File contents can be - commented freely with the ``#`` character. Leading- and + -f file Read commands from a file. This file can be commented + freely with the ``#`` character. Leading- and trailing whitespace on a line are ignored. -h Print help information @@ -91,8 +91,15 @@ -v Print detailed program version information and exit -The last option on the command line is an (optional) command to run. -``tsshbatch`` will attempt to execute it on every host you've +If the ``-H`` option is not selected, the item immediately following +the options is understood to be the name of the ``hostlistfile``. +This is a file that contains the name of each host - one per line - on +which to run the commands. This file can be commented freely with the +``#`` character. Leading- and trailing whitespace on a line are +ignored. + +The last entry on the command line is optional and defines a command +to run. ``tsshbatch`` will attempt to execute it on every host you've specified either via ``-H`` or a ``hostfile``:: tsshbatch.py -Hmyhost ls -al /etc @@ -107,7 +114,7 @@ If you've specified a file containing the commands you want run via the ``-f`` option, these commands will run *before* the command you've defined on the command line. It is always the last command -run on each server. +run on each host. ``tsshbatch`` does all the ``GETs``, then all the ``PUTs`` before attempting to do any command processing. If no ``GETs``, ``PUTs``, or @@ -408,7 +415,7 @@ string indicating something is wrong. ``tsshbatch`` looks for this to let you know that you've got a problem and then terminates further operation. This is so that you do not attempt to log in -with a bad password across all the servers you have targeted. (Many +with a bad password across all the hosts you have targeted. (Many enterprises have policies to lock out a user ID after some small number of failed login/access attempts.) @@ -451,7 +458,7 @@ :: - $Id: tsshbatch.rst,v 1.117 2013/10/23 19:17:38 tundra Exp $ + $Id: tsshbatch.rst,v 1.118 2013/10/23 19:28:17 tundra Exp $ You can find the latest version of this program at: