multiSSH3 4.76__tar.gz → 4.83__tar.gz

{multissh3-4.76 → multissh3-4.83}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: multiSSH3
-Version: 4.76
+Version: 4.83
 Summary: Run commands on multiple hosts via SSH
 Home-page: https://github.com/yufei-pan/multiSSH3
 Author: Yufei Pan
@@ -19,6 +19,45 @@ A script that is able to issue commands to multiple hosts while monitoring their
 Can be used in bash scripts for automation actions.
 Also able to be imported and / or use with Flexec SSH Backend to perform cluster automation actions.
 
+Install via
+```
+pip install multiSSH3
+```
+
+multiSSH3 will be available as
+```
+mssh
+mssh3
+multissh
+multissh3
+multiSSH3
+```
+
+multissh will read a config file located at ```/etc/multiSSH3.config.json```
+
+To store / generate a config file with the current command line options, you can use
+
+```
+mssh --generate_default_config_file
+```
+
+You can modify the json file directly after generation and multissh will read from it for loading defaults. 
+
+Note:
+
+If you want to store password, it will be a plain text password in this config file. This will be better to supply it everytime as a CLI argument but you should really consider setting up priv-pub key setup.
+
+This option can also be used to store cli options into the config files. For example.
+
+```
+mssh --ipmi_interface_ip_prefix 192 --generate_default_config_file
+```
+will store 
+```
+"DEFAULT_IPMI_INTERFACE_IP_PREFIX": "192"
+```
+into the json file.
+
 By defualt reads bash env variables for hostname aliases. Also able to read
 ```
 DEFAULT_ENV_FILE = '/etc/profile.d/hosts.sh'
@@ -28,20 +67,20 @@ as hostname aliases.
 For example:
 ```
 export all='192.168.1-2.1-64'
-multiSSH3.py all 'echo hi'
+mssh all 'echo hi'
 ```
 
 It is also able to recognize ip blocks / number blocks / hex blocks / character blocks directly.
 
 For example:
 ```
-multiSSH3.py testrig[1-10] lsblk
-multiSSH3.py ww[a-c],10.100.0.* 'cat /etc/fstab' 'sed -i "/lustre/d' /etc/fstab' 'cat /etc/fstab'
+mssh testrig[1-10] lsblk
+mssh ww[a-c],10.100.0.* 'cat /etc/fstab' 'sed -i "/lustre/d' /etc/fstab' 'cat /etc/fstab'
 ```
 
 It also supports interactive inputs. ( and able to async boardcast to all supplied hosts )
 ```
-multiSSH3.py www bash
+mssh www bash
 ```
 
 By default, it will try to fit everything inside your window. 
@@ -52,7 +91,7 @@ DEFAULT_CURSES_MINIMUM_LINE_LEN = 1
 While leaving minimum 40 characters / 1 line for each host display by default. You can modify this by using -ww and -wh.
 
 
-Use ```multiSSH3.py --help``` for more info.
+Use ```mssh --help``` for more info.
 
 ```
 usage: mssh [-h] [-u USERNAME] [-ea EXTRAARGS] [-p PASSWORD] [-11] [-f FILE] [--file_sync] [--scp] [-t TIMEOUT] [-r REPEAT] [-i INTERVAL] [--ipmi]
@@ -121,23 +160,24 @@ Following document is generated courtesy of Mr.ChatGPT-o1 Preview:
 
 ## Table of Contents
 
-- [Features](#features)
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Basic Syntax](#basic-syntax)
-  - [Command-Line Options](#command-line-options)
-- [Examples](#examples)
-  - [Running a Command on Multiple Hosts](#running-a-command-on-multiple-hosts)
-  - [Copying Files to Multiple Hosts](#copying-files-to-multiple-hosts)
-  - [Using Hostname Ranges](#using-hostname-ranges)
-  - [Using IPMI](#using-ipmi)
-  - [Using Password Authentication](#using-password-authentication)
-  - [Skipping Unreachable Hosts](#skipping-unreachable-hosts)
-  - [JSON Output](#json-output)
-  - [Quiet Mode](#quiet-mode)
-- [Environment Variables](#environment-variables)
-- [Notes](#notes)
-- [License](#license)
+- [multiSSH3](#multissh3)
+- [multissh](#multissh)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+    - [Basic Syntax](#basic-syntax)
+    - [Command-Line Options](#command-line-options)
+  - [Examples](#examples)
+    - [Running a Command on Multiple Hosts](#running-a-command-on-multiple-hosts)
+    - [Copying Files to Multiple Hosts](#copying-files-to-multiple-hosts)
+    - [Using Hostname Ranges](#using-hostname-ranges)
+    - [Using IPMI](#using-ipmi)
+    - [Using Password Authentication](#using-password-authentication)
+    - [Skipping Unreachable Hosts](#skipping-unreachable-hosts)
+    - [JSON Output](#json-output)
+    - [Quiet Mode](#quiet-mode)
+  - [Environment Variables](#environment-variables)
+  - [Notes](#notes)
+  - [License](#license)
 
 ## Features
 
@@ -152,36 +192,10 @@ Following document is generated courtesy of Mr.ChatGPT-o1 Preview:
 - **Interactive Mode**: Run interactive commands with curses-based UI for monitoring.
 - **Quiet Mode**: Suppress output for cleaner automation scripts.
 
-## Installation
-
-1. **Clone the Repository**
-
-   ```bash
-   git clone https://github.com/yourusername/multissh.git
-   ```
-
-2. **Navigate to the Directory**
-
-   ```bash
-   cd multissh
-   ```
-
-3. **Make the Script Executable**
-
-   ```bash
-   chmod +x multissh.py
-   ```
-
-4. **Install Dependencies**
-
-   Ensure you have Python 3 and the required modules installed. You may need to install `curses` and `ipaddress` modules if they are not already available.
-
-## Usage
-
 ### Basic Syntax
 
 ```bash
-./multissh.py [options] <hosts> <commands>
+mssh [options] <hosts> <commands>
 ```
 
 - `<hosts>`: Comma-separated list of target hosts. Supports ranges and wildcards.
@@ -225,7 +239,7 @@ Following document is generated courtesy of Mr.ChatGPT-o1 Preview:
 ### Running a Command on Multiple Hosts
 
 ```bash
-./multissh.py "host1,host2,host3" "uptime"
+mssh "host1,host2,host3" "uptime"
 ```
 
 This command runs `uptime` on `host1`, `host2`, and `host3`.
@@ -233,7 +247,7 @@ This command runs `uptime` on `host1`, `host2`, and `host3`.
 ### Copying Files to Multiple Hosts
 
 ```bash
-./multissh.py -f "/path/to/local/file.txt" "host1,host2,host3" "/remote/path/"
+mssh -f "/path/to/local/file.txt" "host1,host2,host3" "/remote/path/"
 ```
 
 This command copies `file.txt` to `/remote/path/` on the specified hosts.
@@ -241,7 +255,7 @@ This command copies `file.txt` to `/remote/path/` on the specified hosts.
 ### Using Hostname Ranges
 
 ```bash
-./multissh.py "host[01-05]" "hostname"
+mssh "host[01-05]" "hostname"
 ```
 
 This expands to `host01`, `host02`, `host03`, `host04`, `host05` and runs `hostname` on each.
@@ -249,7 +263,7 @@ This expands to `host01`, `host02`, `host03`, `host04`, `host05` and runs `hostn
 ### Using IPMI
 
 ```bash
-./multissh.py --ipmi "192.168.1.[100-105]" "chassis power status"
+mssh --ipmi "192.168.1.[100-105]" "chassis power status"
 ```
 
 Runs `ipmitool chassis power status` on the specified IPMI interfaces.
@@ -257,7 +271,7 @@ Runs `ipmitool chassis power status` on the specified IPMI interfaces.
 ### Using Password Authentication
 
 ```bash
-./multissh.py -p "yourpassword" "host1,host2" "whoami"
+mssh -p "yourpassword" "host1,host2" "whoami"
 ```
 
 Uses `sshpass` to provide the password for SSH authentication.
@@ -265,7 +279,7 @@ Uses `sshpass` to provide the password for SSH authentication.
 ### Skipping Unreachable Hosts
 
 ```bash
-./multissh.py -su "host1,host2,host3" "date"
+mssh -su "host1,host2,host3" "date"
 ```
 
 Skips hosts that are unreachable during execution.
@@ -273,7 +287,7 @@ Skips hosts that are unreachable during execution.
 ### JSON Output
 
 ```bash
-./multissh.py -j "host1,host2" "uname -a"
+mssh -j "host1,host2" "uname -a"
 ```
 
 Outputs the results in JSON format, suitable for parsing.
@@ -281,7 +295,7 @@ Outputs the results in JSON format, suitable for parsing.
 ### Quiet Mode
 
 ```bash
-./multissh.py -q "host1,host2" "ls /nonexistent"
+mssh -q "host1,host2" "ls /nonexistent"
 ```
 
 Suppresses all output, useful for scripts where you only care about exit codes.

{multissh3-4.76 → multissh3-4.83}/README.md

@@ -3,6 +3,45 @@ A script that is able to issue commands to multiple hosts while monitoring their
 Can be used in bash scripts for automation actions.
 Also able to be imported and / or use with Flexec SSH Backend to perform cluster automation actions.
 
+Install via
+```
+pip install multiSSH3
+```
+
+multiSSH3 will be available as
+```
+mssh
+mssh3
+multissh
+multissh3
+multiSSH3
+```
+
+multissh will read a config file located at ```/etc/multiSSH3.config.json```
+
+To store / generate a config file with the current command line options, you can use
+
+```
+mssh --generate_default_config_file
+```
+
+You can modify the json file directly after generation and multissh will read from it for loading defaults. 
+
+Note:
+
+If you want to store password, it will be a plain text password in this config file. This will be better to supply it everytime as a CLI argument but you should really consider setting up priv-pub key setup.
+
+This option can also be used to store cli options into the config files. For example.
+
+```
+mssh --ipmi_interface_ip_prefix 192 --generate_default_config_file
+```
+will store 
+```
+"DEFAULT_IPMI_INTERFACE_IP_PREFIX": "192"
+```
+into the json file.
+
 By defualt reads bash env variables for hostname aliases. Also able to read
 ```
 DEFAULT_ENV_FILE = '/etc/profile.d/hosts.sh'
@@ -12,20 +51,20 @@ as hostname aliases.
 For example:
 ```
 export all='192.168.1-2.1-64'
-multiSSH3.py all 'echo hi'
+mssh all 'echo hi'
 ```
 
 It is also able to recognize ip blocks / number blocks / hex blocks / character blocks directly.
 
 For example:
 ```
-multiSSH3.py testrig[1-10] lsblk
-multiSSH3.py ww[a-c],10.100.0.* 'cat /etc/fstab' 'sed -i "/lustre/d' /etc/fstab' 'cat /etc/fstab'
+mssh testrig[1-10] lsblk
+mssh ww[a-c],10.100.0.* 'cat /etc/fstab' 'sed -i "/lustre/d' /etc/fstab' 'cat /etc/fstab'
 ```
 
 It also supports interactive inputs. ( and able to async boardcast to all supplied hosts )
 ```
-multiSSH3.py www bash
+mssh www bash
 ```
 
 By default, it will try to fit everything inside your window. 
@@ -36,7 +75,7 @@ DEFAULT_CURSES_MINIMUM_LINE_LEN = 1
 While leaving minimum 40 characters / 1 line for each host display by default. You can modify this by using -ww and -wh.
 
 
-Use ```multiSSH3.py --help``` for more info.
+Use ```mssh --help``` for more info.
 
 ```
 usage: mssh [-h] [-u USERNAME] [-ea EXTRAARGS] [-p PASSWORD] [-11] [-f FILE] [--file_sync] [--scp] [-t TIMEOUT] [-r REPEAT] [-i INTERVAL] [--ipmi]
@@ -105,23 +144,24 @@ Following document is generated courtesy of Mr.ChatGPT-o1 Preview:
 
 ## Table of Contents
 
-- [Features](#features)
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Basic Syntax](#basic-syntax)
-  - [Command-Line Options](#command-line-options)
-- [Examples](#examples)
-  - [Running a Command on Multiple Hosts](#running-a-command-on-multiple-hosts)
-  - [Copying Files to Multiple Hosts](#copying-files-to-multiple-hosts)
-  - [Using Hostname Ranges](#using-hostname-ranges)
-  - [Using IPMI](#using-ipmi)
-  - [Using Password Authentication](#using-password-authentication)
-  - [Skipping Unreachable Hosts](#skipping-unreachable-hosts)
-  - [JSON Output](#json-output)
-  - [Quiet Mode](#quiet-mode)
-- [Environment Variables](#environment-variables)
-- [Notes](#notes)
-- [License](#license)
+- [multiSSH3](#multissh3)
+- [multissh](#multissh)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+    - [Basic Syntax](#basic-syntax)
+    - [Command-Line Options](#command-line-options)
+  - [Examples](#examples)
+    - [Running a Command on Multiple Hosts](#running-a-command-on-multiple-hosts)
+    - [Copying Files to Multiple Hosts](#copying-files-to-multiple-hosts)
+    - [Using Hostname Ranges](#using-hostname-ranges)
+    - [Using IPMI](#using-ipmi)
+    - [Using Password Authentication](#using-password-authentication)
+    - [Skipping Unreachable Hosts](#skipping-unreachable-hosts)
+    - [JSON Output](#json-output)
+    - [Quiet Mode](#quiet-mode)
+  - [Environment Variables](#environment-variables)
+  - [Notes](#notes)
+  - [License](#license)
 
 ## Features
 
@@ -136,36 +176,10 @@ Following document is generated courtesy of Mr.ChatGPT-o1 Preview:
 - **Interactive Mode**: Run interactive commands with curses-based UI for monitoring.
 - **Quiet Mode**: Suppress output for cleaner automation scripts.
 
-## Installation
-
-1. **Clone the Repository**
-
-   ```bash
-   git clone https://github.com/yourusername/multissh.git
-   ```
-
-2. **Navigate to the Directory**
-
-   ```bash
-   cd multissh
-   ```
-
-3. **Make the Script Executable**
-
-   ```bash
-   chmod +x multissh.py
-   ```
-
-4. **Install Dependencies**
-
-   Ensure you have Python 3 and the required modules installed. You may need to install `curses` and `ipaddress` modules if they are not already available.
-
-## Usage
-
 ### Basic Syntax
 
 ```bash
-./multissh.py [options] <hosts> <commands>
+mssh [options] <hosts> <commands>
 ```
 
 - `<hosts>`: Comma-separated list of target hosts. Supports ranges and wildcards.
@@ -209,7 +223,7 @@ Following document is generated courtesy of Mr.ChatGPT-o1 Preview:
 ### Running a Command on Multiple Hosts
 
 ```bash
-./multissh.py "host1,host2,host3" "uptime"
+mssh "host1,host2,host3" "uptime"
 ```
 
 This command runs `uptime` on `host1`, `host2`, and `host3`.
@@ -217,7 +231,7 @@ This command runs `uptime` on `host1`, `host2`, and `host3`.
 ### Copying Files to Multiple Hosts
 
 ```bash
-./multissh.py -f "/path/to/local/file.txt" "host1,host2,host3" "/remote/path/"
+mssh -f "/path/to/local/file.txt" "host1,host2,host3" "/remote/path/"
 ```
 
 This command copies `file.txt` to `/remote/path/` on the specified hosts.
@@ -225,7 +239,7 @@ This command copies `file.txt` to `/remote/path/` on the specified hosts.
 ### Using Hostname Ranges
 
 ```bash
-./multissh.py "host[01-05]" "hostname"
+mssh "host[01-05]" "hostname"
 ```
 
 This expands to `host01`, `host02`, `host03`, `host04`, `host05` and runs `hostname` on each.
@@ -233,7 +247,7 @@ This expands to `host01`, `host02`, `host03`, `host04`, `host05` and runs `hostn
 ### Using IPMI
 
 ```bash
-./multissh.py --ipmi "192.168.1.[100-105]" "chassis power status"
+mssh --ipmi "192.168.1.[100-105]" "chassis power status"
 ```
 
 Runs `ipmitool chassis power status` on the specified IPMI interfaces.
@@ -241,7 +255,7 @@ Runs `ipmitool chassis power status` on the specified IPMI interfaces.
 ### Using Password Authentication
 
 ```bash
-./multissh.py -p "yourpassword" "host1,host2" "whoami"
+mssh -p "yourpassword" "host1,host2" "whoami"
 ```
 
 Uses `sshpass` to provide the password for SSH authentication.
@@ -249,7 +263,7 @@ Uses `sshpass` to provide the password for SSH authentication.
 ### Skipping Unreachable Hosts
 
 ```bash
-./multissh.py -su "host1,host2,host3" "date"
+mssh -su "host1,host2,host3" "date"
 ```
 
 Skips hosts that are unreachable during execution.
@@ -257,7 +271,7 @@ Skips hosts that are unreachable during execution.
 ### JSON Output
 
 ```bash
-./multissh.py -j "host1,host2" "uname -a"
+mssh -j "host1,host2" "uname -a"
 ```
 
 Outputs the results in JSON format, suitable for parsing.
@@ -265,7 +279,7 @@ Outputs the results in JSON format, suitable for parsing.
 ### Quiet Mode
 
 ```bash
-./multissh.py -q "host1,host2" "ls /nonexistent"
+mssh -q "host1,host2" "ls /nonexistent"
 ```
 
 Suppresses all output, useful for scripts where you only care about exit codes.