2019-10-21 11:31:07 +02:00
|
|
|
Use Ansible instead
|
|
|
|
===================
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
These utilities are script allowing one to work in parallel with a number of
|
|
|
|
remote hosts, using utilities such as Parallel SSH (pssh) or fping. Nowadays,
|
|
|
|
you're much better off using Ansible, which covers everything these scripts do,
|
|
|
|
and much more. The only exception might be `tabssh.sh`.
|
|
|
|
|
|
|
|
Original documentation
|
|
|
|
======================
|
|
|
|
|
|
|
|
All these scripts take as first and mandatory positional argument a host list
|
|
|
|
name “NAME”; the list will be searched according to the following pattern:
|
|
|
|
|
|
|
|
$XDG_CONFIG_HOME/ssh_tools/NAME.lst
|
2018-05-18 16:39:02 +02:00
|
|
|
|
|
|
|
(`$XDG_CONFIG_HOME` being equivalent to `$HOME/.config` if unset.)
|
2019-10-21 11:31:07 +02:00
|
|
|
For example, one can call the `multiping.sh` script typing:
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
multiping my_hosts
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
to use the hosts' file `$XDG_CONFIG_HOME/ssh_tools/my_hosts.lst`.
|
2018-05-18 16:39:02 +02:00
|
|
|
|
|
|
|
The format of such a .lst file is one line per host name or IP address,
|
|
|
|
for example:
|
|
|
|
|
|
|
|
```
|
|
|
|
192.168.42.1
|
|
|
|
192.168.42.3
|
|
|
|
priam
|
|
|
|
```
|
|
|
|
|
|
|
|
The scripts based on SSH use the local user's login name as remote login;
|
|
|
|
this can be changed using the `-l` option, that must appear before the
|
|
|
|
hosts list on the command line, for example:
|
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
multissh -l root openwrt_machines opkg install screen
|
2018-05-18 16:39:02 +02:00
|
|
|
|
|
|
|
The provided scripts are detailed in the sequel.
|
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
multiping.sh
|
|
|
|
------------
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
Tests the connectivity with the hosts of the list by sending them a ICMP
|
2018-05-18 16:39:02 +02:00
|
|
|
echo packet.
|
|
|
|
|
|
|
|
**Dependency**: `fping`
|
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
**Ansible replacement**:
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
ansible <group> -m ping
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
tabssh.sh
|
|
|
|
---------
|
|
|
|
|
|
|
|
Opens a GNU Screen tab with an interactive SSH session for each host of
|
2018-05-18 16:39:02 +02:00
|
|
|
the hosts list. Must be run inside of an existing Screen.
|
|
|
|
|
|
|
|
**Dependencies**: `screen`, `ssh`
|
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
**Ansible replacement**: not really. Maybe see this StackOverflow question for
|
|
|
|
inspiration:
|
|
|
|
<https://stackoverflow.com/questions/47887379/how-could-i-open-a-ssh-shell-to-remote-with-ansible>
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
multissh.sh
|
|
|
|
-----------
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
Runs the same command on every host of the hosts list.
|
2018-05-18 16:39:02 +02:00
|
|
|
|
|
|
|
**Dependency**: `parallel-ssh` (`pssh`)
|
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
**Ansible replacement**: use Ansible's `command` module (i.e. the default
|
|
|
|
module), or the `shell` module if using pipes or redirections.
|
|
|
|
|
|
|
|
ansible <group> -a '<command>'
|
|
|
|
ansible <group> -m shell -a '<command with pipes>'
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
multicopy.sh
|
|
|
|
------------
|
2018-05-18 16:39:02 +02:00
|
|
|
|
2019-10-21 11:31:07 +02:00
|
|
|
Deploys one or more files in parallel on every host of the hosts list.
|
2018-05-18 16:39:02 +02:00
|
|
|
The files are copied in the remote user's home directory.
|
|
|
|
|
|
|
|
By default, the files are transferred one by one, to make sure you notice
|
|
|
|
the errors for each file (bad permissions, out of space, etc.), but you
|
2019-10-21 11:31:07 +02:00
|
|
|
can use the `-P` switch to transfer them all at once (which is much faster).
|
2018-05-18 16:39:02 +02:00
|
|
|
|
|
|
|
While it is possible to transfer directories with the default option, to
|
|
|
|
synchronise directories one would rather use the `-r` option, that uses
|
|
|
|
prsync rather than pscp to transfer the files. With the `-R` option, the
|
|
|
|
remote files that are not in the local copy will be deleted (rsync's
|
|
|
|
`--delete` option). In both cases, the transfer is done with rsync's `-a`
|
|
|
|
(archive) option.
|
|
|
|
|
|
|
|
Please note that unlike rsync, prsync cannot handle multiple local files,
|
|
|
|
therefore the `-P` option is ignored when passed along with `-r` or `-R`.
|
|
|
|
|
2019-10-21 16:37:56 +02:00
|
|
|
**Dependencies (optional)**: `parallel-scp` (`pscp`), `parallel-rsync`
|
|
|
|
(`prsync`), `multiping` (see above)
|
2019-10-21 11:31:07 +02:00
|
|
|
|
|
|
|
**Ansible replacement**: use Ansible `copy` module. See also modules `fetch`
|
|
|
|
(to retrieve files instead of pushing them), `synchronize`, `rsync` and
|
|
|
|
`unarchive`.
|
|
|
|
|
|
|
|
ansible <group> -m copy -a 'src=/local/path dest=/remote/path'
|