diff options
author | kshithijiyer <kshithij.ki@gmail.com> | 2020-05-29 19:26:39 +0530 |
---|---|---|
committer | kshithijiyer <kshithij.ki@gmail.com> | 2020-06-01 12:24:11 +0530 |
commit | 3979be96355f1bc694056c036928df9b71117870 (patch) | |
tree | 514ad60ae7246c51eb40cc0e5c98cb601fb21223 /tools/get_sosreports/README.md | |
parent | 1e82a9e5a2275edc5fdfd40d7f9b79334da7682f (diff) |
[Tool] Add tool to fetch sosreports
Adding tool to fetch sosreports from all servers
and clients using glusto-tests config file.
This tool is essentially just a tweeked version
of getsos[1] tool which can take glusto-tests config file
and is relicensed under GPLv3+.
Reference:
[1] https://github.com/kshithijiyer/getsos
Change-Id: Ic1685163154ed4358064397d74d3965097448621
Signed-off-by: kshithijiyer <kshithij.ki@gmail.com>
Diffstat (limited to 'tools/get_sosreports/README.md')
-rw-r--r-- | tools/get_sosreports/README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/tools/get_sosreports/README.md b/tools/get_sosreports/README.md new file mode 100644 index 000000000..57176f27f --- /dev/null +++ b/tools/get_sosreports/README.md @@ -0,0 +1,45 @@ +# get_sosreports +Tool to collect sosreports from all servers and clients. + +## Prerequisites +1. Python 3.x +2. Passwordless ssh should be setup. + +## Installation +1. Change directory to the project directory. + +``` +# cd tools/get_sosreports +``` + +2. Now run the installation script. + +``` +# python3 setup.py install +``` + +3. To check run: + +``` +# get_sosreports --help +``` + +## Usage +There are 2 ways of using the tool. +1. Passing IP addresses through command line seperated by comma(,): + +``` +# get_sosreports -m machine_1,machine_2,machine_3 +``` + +2. Passing a glusto-tests config file: + +``` +# get_sosreports -f config_file +``` + +**Note**: +The default destination directory is `.` (present dir) `-d` or `--dist-dir` option. + +## Licence +[GPLv3](https://github.com/gluster/glusto-tests/blob/master/LICENSE) |