multiSSH3 4.97__py3-none-any.whl → 4.99__py3-none-any.whl

{multiSSH3-4.97.dist-info → multiSSH3-4.99.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: multiSSH3
-Version: 4.97
+Version: 4.99
 Summary: Run commands on multiple hosts via SSH
 Home-page: https://github.com/yufei-pan/multiSSH3
 Author: Yufei Pan
@@ -38,7 +38,7 @@ 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
 
 ```bash
-mssh --generate_default_config_file
+mssh --store_config_file
 ```
 
 You can modify the json file directly after generation and multissh will read from it for loading defaults. 
@@ -47,10 +47,14 @@ 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.
 
+Also Note:
+
+On some systems, scp / rsync will require you use a priv-pub key to work
+
 This option can also be used to store cli options into the config files. For example.
 
 ```bash
-mssh --ipmi_interface_ip_prefix 192 --generate_default_config_file
+mssh --ipmi_interface_ip_prefix 192 --store_config_file
 ```
 will store 
 ```json
@@ -64,6 +68,22 @@ DEFAULT_ENV_FILE = '/etc/profile.d/hosts.sh'
 ```
 as hostname aliases.
 
+multissh3 will resolve hostname grouping by:
+  ipv4 address expansion > local hostname resolution ( like /etc/hosts ) > currrent terminal environment >  env from env_file > remote hostname resolution ( socket.gethostbyname() )
+
+An example hostname alias file will look like:
+```bash
+us_east='100.100.0.1-3,us_east_prod_[1-5]'
+us_central=""
+us_west="100.101.0.1-2,us_west_prod_[a-c]_[1-3]"
+us="$us_east,$us_central,$us_west"
+asia="100.90.0-1,1-9"
+eu=''
+rhel8="$asia,$us_east"
+all="$us,$asia,$eu"
+```
+( You can use bash replacements for grouping. )
+
 For example:
 ```bash
 export all='192.168.1-2.1-64'
@@ -104,61 +124,73 @@ While leaving minimum 40 characters / 1 line for each host display by default. Y
 Use ```mssh --help``` for more info.
 
 ```bash
-usage: mssh [-h] [-u USERNAME] [-ea EXTRAARGS] [-p PASSWORD] [-11] [-f FILE] [--file_sync] [--scp] [-t TIMEOUT] [-r REPEAT] [-i INTERVAL] [--ipmi]
-            [-pre INTERFACE_IP_PREFIX] [-q] [-ww WINDOW_WIDTH] [-wh WINDOW_HEIGHT] [-sw] [-eo] [-no] [--no_env] [--env_file ENV_FILE] [-m MAXCONNECTIONS] [-j]
-            [--success_hosts] [-g] [-nw] [-su] [-sh SKIPHOSTS] [-V]
-            hosts commands [commands ...]
+usage: mssh [-h] [-u USERNAME] [-p PASSWORD] [-ea EXTRAARGS] [-11] [-f FILE] [-fs] [--scp] [-gm] [-t TIMEOUT] [-r REPEAT] [-i INTERVAL]
+            [--ipmi] [-mpre IPMI_INTERFACE_IP_PREFIX] [-pre INTERFACE_IP_PREFIX] [-q] [-ww WINDOW_WIDTH] [-wh WINDOW_HEIGHT] [-sw] [-eo]
+            [-no] [--no_env] [--env_file ENV_FILE] [-m MAX_CONNECTIONS] [-j] [--success_hosts] [-g] [-su] [-sh SKIP_HOSTS]
+            [--store_config_file] [--debug] [--copy-id] [-V]
+            [hosts] [commands ...]
 
-Run a command on multiple hosts, Use #HOST# or #HOSTNAME# to replace the host name in the command
+Run a command on multiple hosts, Use #HOST# or #HOSTNAME# to replace the host name in the command. Config file: /etc/multiSSH3.config.json
 
 positional arguments:
-  hosts                 Hosts to run the command on, use "," to seperate hosts
-  commands              the command to run on the hosts / the destination of the files #HOST# or #HOSTNAME# will be replaced with the host name.
+  hosts                 Hosts to run the command on, use "," to seperate hosts. (default: all)
+  commands              the command to run on the hosts / the destination of the files #HOST# or #HOSTNAME# will be replaced with the host
+                        name.
 
 options:
   -h, --help            show this help message and exit
   -u USERNAME, --username USERNAME
-                        The general username to use to connect to the hosts. Will get overwrote by individual username@host if specified. (default: None)
-  -ea EXTRAARGS, --extraargs EXTRAARGS
-                        Extra arguments to pass to the ssh / rsync / scp command. Put in one string for multiple arguments.Use "=" ! Ex. -ea="--delete" (default:
-                        None)
+                        The general username to use to connect to the hosts. Will get overwrote by individual username@host if specified.
+                        (default: None)
   -p PASSWORD, --password PASSWORD
-                        The password to use to connect to the hosts, (default: hermes)
+                        The password to use to connect to the hosts, (default: )
+  -ea EXTRAARGS, --extraargs EXTRAARGS
+                        Extra arguments to pass to the ssh / rsync / scp command. Put in one string for multiple arguments.Use "=" ! Ex.
+                        -ea="--delete" (default: None)
   -11, --oneonone       Run one corresponding command on each host. (default: False)
   -f FILE, --file FILE  The file to be copied to the hosts. Use -f multiple times to copy multiple files
-  --file_sync           Operate in file sync mode, sync path in <COMMANDS> from this machine to <HOSTS>. Treat --file <FILE> and <COMMANDS> both as source as source
-                        and destination will be the same in this mode. (default: False)
+  -fs, --file_sync      Operate in file sync mode, sync path in <COMMANDS> from this machine to <HOSTS>. Treat --file <FILE> and
+                        <COMMANDS> both as source as source and destination will be the same in this mode. (default: False)
   --scp                 Use scp for copying files instead of rsync. Need to use this on windows. (default: False)
+  -gm, --gather_mode    Gather files from the hosts instead of sending files to the hosts. Will send remote files specified in <FILE> to
+                        local path specified in <COMMANDS> (default: False)
   -t TIMEOUT, --timeout TIMEOUT
-                        Timeout for each command in seconds (default: 0 (disabled))
+                        Timeout for each command in seconds (default: 600 (disabled))
   -r REPEAT, --repeat REPEAT
                         Repeat the command for a number of times (default: 1)
   -i INTERVAL, --interval INTERVAL
                         Interval between repeats in seconds (default: 0)
   --ipmi                Use ipmitool to run the command. (default: False)
+  -mpre IPMI_INTERFACE_IP_PREFIX, --ipmi_interface_ip_prefix IPMI_INTERFACE_IP_PREFIX
+                        The prefix of the IPMI interfaces (default: )
   -pre INTERFACE_IP_PREFIX, --interface_ip_prefix INTERFACE_IP_PREFIX
                         The prefix of the for the interfaces (default: None)
-  -q, --quiet           Quiet mode, no curses, only print the output. (default: False)
+  -q, -nw, --nowatch, --quiet
+                        Quiet mode, no curses watch, only print the output. (default: False)
   -ww WINDOW_WIDTH, --window_width WINDOW_WIDTH
                         The minimum character length of the curses window. (default: 40)
   -wh WINDOW_HEIGHT, --window_height WINDOW_HEIGHT
-                        The minimum line height of the curses window. (default: 1)
+                        The minimum line height of the curses window. (default: 5)
   -sw, --single_window  Use a single window for all hosts. (default: False)
   -eo, --error_only     Only print the error output. (default: False)
-  -no, --nooutput       Do not print the output. (default: False)
-  --no_env              Do not load the environment variables. (default: False)
-  --env_file ENV_FILE   The file to load the environment variables from. (default: /etc/profile.d/hosts.sh)
-  -m MAXCONNECTIONS, --maxconnections MAXCONNECTIONS
+  -no, --no_output      Do not print the output. (default: False)
+  --no_env              Do not load the command line environment variables. (default: False)
+  --env_file ENV_FILE   The file to load the mssh file based environment variables from. ( Still work with --no_env ) (default:
+                        /etc/profile.d/hosts.sh)
+  -m MAX_CONNECTIONS, --max_connections MAX_CONNECTIONS
                         Max number of connections to use (default: 4 * cpu_count)
   -j, --json            Output in json format. (default: False)
   --success_hosts       Output the hosts that succeeded in summary as wells. (default: False)
   -g, --greppable       Output in greppable format. (default: False)
-  -nw, --nowatch        Do not watch the output in curses modem, Use \r. Not implemented yet. (default: False)
-  -su, --skipunreachable
-                        Skip unreachable hosts while using --repeat. Note: Timedout Hosts are considered unreachable. Note: multiple command sequence will still auto
-                        skip unreachable hosts. (default: False)
-  -sh SKIPHOSTS, --skiphosts SKIPHOSTS
-                        Skip the hosts in the list. (default: )
+  -su, --skip_unreachable
+                        Skip unreachable hosts while using --repeat. Note: Timedout Hosts are considered unreachable. Note: multiple
+                        command sequence will still auto skip unreachable hosts. (default: False)
+  -sh SKIP_HOSTS, --skip_hosts SKIP_HOSTS
+                        Skip the hosts in the list. (default: None)
+  --store_config_file   Store / generate the default config file from command line argument and current config at
+                        /etc/multiSSH3.config.json
+  --debug               Print debug information
+  --copy-id             Copy the ssh id to the hosts
   -V, --version         show program's version number and exit
 ```
 

multiSSH3-4.99.dist-info/RECORD

@@ -0,0 +1,7 @@
+multiSSH3.py,sha256=MdhvFCCWxQCZkjqFcsCp9nwiYiB1jKg1_YLu6BBrqZ4,96689
+multiSSH3-4.99.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+multiSSH3-4.99.dist-info/METADATA,sha256=cLbJhPOIt81YaMyAn5iOocyPvEST-3RRFP-uafmZm30,17517
+multiSSH3-4.99.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+multiSSH3-4.99.dist-info/entry_points.txt,sha256=xi2rWWNfmHx6gS8Mmx0rZL2KZz6XWBYP3DWBpWAnnZ0,143
+multiSSH3-4.99.dist-info/top_level.txt,sha256=tUwttxlnpLkZorSsroIprNo41lYSxjd2ASuL8-EJIJw,10
+multiSSH3-4.99.dist-info/RECORD,,

{multiSSH3-4.97.dist-info → multiSSH3-4.99.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

multiSSH3.py

@@ -30,7 +30,7 @@ except AttributeError:
 		# If neither is available, use a dummy decorator
 		def cache_decorator(func):
 			return func
-version = '4.97'
+version = '4.99'
 VERSION = version
 
 CONFIG_FILE = '/etc/multiSSH3.config.json'	
@@ -68,6 +68,9 @@ __build_in_default_config = {
 	'DEFAULT_HOSTS': 'all',
 	'DEFAULT_USERNAME': None,
 	'DEFAULT_PASSWORD': '',
+	'DEFAULT_IDENTITY_FILE': None,
+	'DEDAULT_SSH_KEY_SEARCH_PATH': '~/.ssh/',
+	'DEFAULT_USE_KEY': False,
 	'DEFAULT_EXTRA_ARGS': None,
 	'DEFAULT_ONE_ON_ONE': False,
 	'DEFAULT_SCP': False,
@@ -115,6 +118,7 @@ __build_in_default_config = {
 	'_rsyncPath': None,
 	'_bashPath': None,
 	'__ERROR_MESSAGES_TO_IGNORE_REGEX':None,
+	'__DEBUG_MODE': False,
 }
 
 AUTHOR = __configs_from_file.get('AUTHOR', __build_in_default_config['AUTHOR'])
@@ -124,6 +128,9 @@ DEFAULT_HOSTS = __configs_from_file.get('DEFAULT_HOSTS', __build_in_default_conf
 DEFAULT_ENV_FILE = __configs_from_file.get('DEFAULT_ENV_FILE', __build_in_default_config['DEFAULT_ENV_FILE'])
 DEFAULT_USERNAME = __configs_from_file.get('DEFAULT_USERNAME', __build_in_default_config['DEFAULT_USERNAME'])
 DEFAULT_PASSWORD = __configs_from_file.get('DEFAULT_PASSWORD', __build_in_default_config['DEFAULT_PASSWORD'])
+DEFAULT_IDENTITY_FILE = __configs_from_file.get('DEFAULT_IDENTITY_FILE', __build_in_default_config['DEFAULT_IDENTITY_FILE'])
+DEDAULT_SSH_KEY_SEARCH_PATH = __configs_from_file.get('DEDAULT_SSH_KEY_SEARCH_PATH', __build_in_default_config['DEDAULT_SSH_KEY_SEARCH_PATH'])
+DEFAULT_USE_KEY = __configs_from_file.get('DEFAULT_USE_KEY', __build_in_default_config['DEFAULT_USE_KEY'])
 DEFAULT_EXTRA_ARGS = __configs_from_file.get('DEFAULT_EXTRA_ARGS', __build_in_default_config['DEFAULT_EXTRA_ARGS'])
 DEFAULT_ONE_ON_ONE = __configs_from_file.get('DEFAULT_ONE_ON_ONE', __build_in_default_config['DEFAULT_ONE_ON_ONE'])
 DEFAULT_SCP = __configs_from_file.get('DEFAULT_SCP', __build_in_default_config['DEFAULT_SCP'])
@@ -168,6 +175,8 @@ if __ERROR_MESSAGES_TO_IGNORE_REGEX:
 else:
 	__ERROR_MESSAGES_TO_IGNORE_REGEX =  re.compile('|'.join(ERROR_MESSAGES_TO_IGNORE))
 
+__DEBUG_MODE = __configs_from_file.get('__DEBUG_MODE', __build_in_default_config['__DEBUG_MODE'])
+
 
 
 __global_suppress_printout = True
@@ -190,9 +199,7 @@ def get_i():
 		return __host_i_counter
 	
 class Host:
-	def __init__(self, name, command, files = None,ipmi = False,interface_ip_prefix = None,scp=False,extraargs=None,gatherMode=False):
-		global __host_i_counter
-		global __host_i_lock
+	def __init__(self, name, command, files = None,ipmi = False,interface_ip_prefix = None,scp=False,extraargs=None,gatherMode=False,identity_file=None):
 		self.name = name # the name of the host (hostname or IP address)
 		self.command = command # the command to run on the host
 		self.returncode = None # the return code of the command
@@ -211,12 +218,13 @@ class Host:
 		# also store a globally unique integer i from 0
 		self.i = get_i()
 		self.uuid = uuid.uuid4()
+		self.identity_file = identity_file
 
 	def __iter__(self):
 		return zip(['name', 'command', 'returncode', 'stdout', 'stderr'], [self.name, self.command, self.returncode, self.stdout, self.stderr])
 	def __repr__(self):
 		# return the complete data structure
-		return f"Host(name={self.name}, command={self.command}, returncode={self.returncode}, stdout={self.stdout}, stderr={self.stderr}, output={self.output}, printedLines={self.printedLines}, files={self.files}, ipmi={self.ipmi}, interface_ip_prefix={self.interface_ip_prefix}, scp={self.scp}, gatherMode={self.gatherMode}, extraargs={self.extraargs}, resolvedName={self.resolvedName}, i={self.i}, uuid={self.uuid})"
+		return f"Host(name={self.name}, command={self.command}, returncode={self.returncode}, stdout={self.stdout}, stderr={self.stderr}, output={self.output}, printedLines={self.printedLines}, files={self.files}, ipmi={self.ipmi}, interface_ip_prefix={self.interface_ip_prefix}, scp={self.scp}, gatherMode={self.gatherMode}, extraargs={self.extraargs}, resolvedName={self.resolvedName}, i={self.i}, uuid={self.uuid}), identity_file={self.identity_file}"
 	def __str__(self):
 		return f"Host(name={self.name}, command={self.command}, returncode={self.returncode}, stdout={self.stdout}, stderr={self.stderr})"
 
@@ -254,7 +262,7 @@ def check_path(program_name):
 		return True
 	return False
 
-[check_path(program) for program in ['sshpass', 'ssh', 'scp', 'ipmitool','rsync','bash']]
+[check_path(program) for program in ['sshpass', 'ssh', 'scp', 'ipmitool','rsync','bash','ssh-copy-id']]
 
 
 
@@ -675,12 +683,15 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 	global __ERROR_MESSAGES_TO_IGNORE_REGEX
 	global __ipmiiInterfaceIPPrefix
 	global _binPaths
+	global __DEBUG_MODE
 	try:
-		keyCheckArgs = []
-		rsyncKeyCheckArgs = []
+		localExtraArgs = []
+		
 		if not SSH_STRICT_HOST_KEY_CHECKING:
-			keyCheckArgs = ['-o StrictHostKeyChecking=no','-o UserKnownHostsFile=/dev/null']
-			rsyncKeyCheckArgs = ['--rsh','ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null']
+			localExtraArgs = ['-o StrictHostKeyChecking=no','-o UserKnownHostsFile=/dev/null']
+		if host.identity_file:
+			localExtraArgs += ['-i',host.identity_file]
+		rsyncLocalExtraArgs = ['--rsh','ssh ' + ' '.join(localExtraArgs)]
 		host.username = None
 		host.address = host.name
 		if '@' in host.name:
@@ -737,6 +748,8 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 						formatedCMD = [_binPaths['ipmitool'],f'-H {host.address}',f'-U {host.username}'] + extraargs + [host.command]
 			elif 'ssh' in _binPaths:
 				host.output.append('Ipmitool not found on the local machine! Trying ipmitool on the remote machine...')
+				if __DEBUG_MODE:
+					host.stderr.append('Ipmitool not found on the local machine! Trying ipmitool on the remote machine...')
 				host.ipmi = False
 				host.interface_ip_prefix = None
 				host.command = 'ipmitool '+host.command if not host.command.startswith('ipmitool ') else host.command
@@ -754,6 +767,8 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 						useScp = True
 					elif 'rsync' in _binPaths:
 						host.output.append('scp not found on the local machine! Trying to use rsync...')
+						if __DEBUG_MODE:
+							host.stderr.append('scp not found on the local machine! Trying to use rsync...')
 						useScp = False
 					else:
 						host.output.append('scp not found on the local machine! Please install scp or rsync to use file sync mode.')
@@ -764,6 +779,8 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 					useScp = False
 				elif 'scp' in _binPaths:
 					host.output.append('rsync not found on the local machine! Trying to use scp...')
+					if __DEBUG_MODE:
+						host.stderr.append('rsync not found on the local machine! Trying to use scp...')
 					useScp = True
 				else:
 					host.output.append('rsync not found on the local machine! Please install rsync or scp to use file sync mode.')
@@ -775,16 +792,17 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 				else:
 					fileArgs = host.files + [f'{host.resolvedName}:{host.command}']
 				if useScp:
-					formatedCMD = [_binPaths['scp'],'-rpB'] + keyCheckArgs + extraargs +['--']+fileArgs
+					formatedCMD = [_binPaths['scp'],'-rpB'] + localExtraArgs + extraargs +['--']+fileArgs
 				else:
-					formatedCMD = [_binPaths['rsync'],'-ahlX','--partial','--inplace', '--info=name'] + rsyncKeyCheckArgs + extraargs +['--']+fileArgs	
+					formatedCMD = [_binPaths['rsync'],'-ahlX','--partial','--inplace', '--info=name'] + rsyncLocalExtraArgs + extraargs +['--']+fileArgs	
 			else:
-				formatedCMD = [_binPaths['ssh']] + keyCheckArgs + extraargs +['--']+ [host.resolvedName, host.command]
+				formatedCMD = [_binPaths['ssh']] + localExtraArgs + extraargs +['--']+ [host.resolvedName, host.command]
 			if passwds and 'sshpass' in _binPaths:
 				formatedCMD = [_binPaths['sshpass'], '-p', passwds] + formatedCMD
 			elif passwds:
 				host.output.append('Warning: sshpass is not available. Please install sshpass to use password authentication.')
-				#host.stderr.append('Warning: sshpass is not available. Please install sshpass to use password authentication.')
+				if __DEBUG_MODE:
+					host.stderr.append('Warning: sshpass is not available. Please install sshpass to use password authentication.')
 				host.output.append('Please provide password via live input or use ssh key authentication.')
 				# # try to send the password via __keyPressesIn
 				# __keyPressesIn[-1] = list(passwds) + ['\n']
@@ -802,6 +820,8 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 	with sem:
 		try:
 			host.output.append('Running command: '+' '.join(formatedCMD))
+			if __DEBUG_MODE:
+				host.stderr.append('Running command: '+' '.join(formatedCMD))
 			#host.stdout = []
 			proc = subprocess.Popen(formatedCMD,stdout=subprocess.PIPE,stderr=subprocess.PIPE,stdin=subprocess.PIPE)
 			# create a thread to handle stdout
@@ -828,7 +848,7 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 
 						proc.terminate()
 						break
-					elif time.time() - host.lastUpdateTime >  min(30, timeout // 2):
+					elif time.time() - host.lastUpdateTime >  max(1, timeout // 2):
 						timeoutLine = f'Timeout in [{timeout - int(time.time() - host.lastUpdateTime)}] seconds!'
 						if host.output and not host.output[-1].strip().startswith(timeoutLine):
 							# remove last line if it is a countdown
@@ -890,6 +910,8 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 	if host.ipmi and host.returncode != 0 and any(['Unable to establish IPMI' in line for line in host.stderr]):
 		host.stderr = []
 		host.output.append('IPMI connection failed! Trying SSH connection...')
+		if __DEBUG_MODE:
+			host.stderr.append('IPMI connection failed! Trying SSH connection...')
 		host.ipmi = False
 		host.interface_ip_prefix = None
 		host.command = 'ipmitool '+host.command if not host.command.startswith('ipmitool ') else host.command
@@ -899,6 +921,8 @@ def ssh_command(host, sem, timeout=60,passwds=None):
 		host.stderr = []
 		host.stdout = []
 		host.output.append('Rsync connection failed! Trying SCP connection...')
+		if __DEBUG_MODE:
+			host.stderr.append('Rsync connection failed! Trying SCP connection...')
 		host.scp = True
 		ssh_command(host,sem,timeout,passwds)
 
@@ -1393,6 +1417,8 @@ def processRunOnHosts(timeout, password, max_connections, hosts, returnUnfinishe
 	# update the unavailable hosts and global unavailable hosts
 	if willUpdateUnreachableHosts:
 		unavailableHosts.update([host.name for host in hosts if host.stderr and ('No route to host' in host.stderr[0].strip() or host.stderr[0].strip().startswith('Timeout!'))])
+		if __DEBUG_MODE:
+			print(f'Unreachable hosts: {unavailableHosts}')
 		__globalUnavailableHosts.update(unavailableHosts)
 		# update the os environment variable if not _no_env
 		if not _no_env:
@@ -1432,12 +1458,13 @@ def __formCommandArgStr(oneonone = DEFAULT_ONE_ON_ONE, timeout = DEFAULT_TIMEOUT
 						 files = None,ipmi = DEFAULT_IPMI,interface_ip_prefix = DEFAULT_INTERFACE_IP_PREFIX,
 						 scp=DEFAULT_SCP,gather_mode = False,username=DEFAULT_USERNAME,extraargs=DEFAULT_EXTRA_ARGS,skipUnreachable=DEFAULT_SKIP_UNREACHABLE,
 						 no_env=DEFAULT_NO_ENV,greppable=DEFAULT_GREPPABLE_MODE,skip_hosts = DEFAULT_SKIP_HOSTS,
-						 file_sync = False, error_only = DEFAULT_ERROR_ONLY,
+						 file_sync = False, error_only = DEFAULT_ERROR_ONLY, identity_file = DEFAULT_IDENTITY_FILE,
 						 shortend = False) -> str:
 	argsList = []
 	if oneonone: argsList.append('--oneonone' if not shortend else '-11')
 	if timeout and timeout != DEFAULT_TIMEOUT: argsList.append(f'--timeout={timeout}' if not shortend else f'-t={timeout}')
 	if password and password != DEFAULT_PASSWORD: argsList.append(f'--password="{password}"' if not shortend else f'-p="{password}"')
+	if identity_file and identity_file != DEFAULT_IDENTITY_FILE: argsList.append(f'--key="{identity_file}"' if not shortend else f'-k="{identity_file}"')
 	if nowatch: argsList.append('--nowatch' if not shortend else '-q')
 	if json: argsList.append('--json' if not shortend else '-j')
 	if max_connections and max_connections != DEFAULT_MAX_CONNECTIONS: argsList.append(f'--max_connections={max_connections}' if not shortend else f'-m={max_connections}')
@@ -1462,7 +1489,7 @@ def getStrCommand(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAULT_ONE_O
 						 scp=DEFAULT_SCP,gather_mode = False,username=DEFAULT_USERNAME,extraargs=DEFAULT_EXTRA_ARGS,skipUnreachable=DEFAULT_SKIP_UNREACHABLE,
 						 no_env=DEFAULT_NO_ENV,greppable=DEFAULT_GREPPABLE_MODE,willUpdateUnreachableHosts=_DEFAULT_UPDATE_UNREACHABLE_HOSTS,no_start=_DEFAULT_NO_START,
 						 skip_hosts = DEFAULT_SKIP_HOSTS, curses_min_char_len = DEFAULT_CURSES_MINIMUM_CHAR_LEN, curses_min_line_len = DEFAULT_CURSES_MINIMUM_LINE_LEN,
-						 single_window = DEFAULT_SINGLE_WINDOW,file_sync = False,error_only = DEFAULT_ERROR_ONLY,
+						 single_window = DEFAULT_SINGLE_WINDOW,file_sync = False,error_only = DEFAULT_ERROR_ONLY, identity_file = DEFAULT_IDENTITY_FILE,
 						 shortend = False):
 	hosts = hosts if type(hosts) == str else frozenset(hosts)
 	hostStr = formHostStr(hosts)
@@ -1471,7 +1498,8 @@ def getStrCommand(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAULT_ONE_O
 						 nowatch = nowatch,json = json,max_connections=max_connections,
 						 files = files,ipmi = ipmi,interface_ip_prefix = interface_ip_prefix,scp=scp,gather_mode = gather_mode,
 						 username=username,extraargs=extraargs,skipUnreachable=skipUnreachable,no_env=no_env,
-						 greppable=greppable,skip_hosts = skip_hosts, file_sync = file_sync,error_only = error_only, shortend = shortend)
+						 greppable=greppable,skip_hosts = skip_hosts, file_sync = file_sync,error_only = error_only, identity_file = identity_file,
+						 shortend = shortend)
 	commandStr = '"' + '" "'.join(commands) + '"' if commands else ''
 	return f'multissh {argsStr} {hostStr} {commandStr}'
 
@@ -1481,7 +1509,7 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 						 scp=DEFAULT_SCP,gather_mode = False,username=DEFAULT_USERNAME,extraargs=DEFAULT_EXTRA_ARGS,skipUnreachable=DEFAULT_SKIP_UNREACHABLE,
 						 no_env=DEFAULT_NO_ENV,greppable=DEFAULT_GREPPABLE_MODE,willUpdateUnreachableHosts=_DEFAULT_UPDATE_UNREACHABLE_HOSTS,no_start=_DEFAULT_NO_START,
 						 skip_hosts = DEFAULT_SKIP_HOSTS, curses_min_char_len = DEFAULT_CURSES_MINIMUM_CHAR_LEN, curses_min_line_len = DEFAULT_CURSES_MINIMUM_LINE_LEN,
-						 single_window = DEFAULT_SINGLE_WINDOW,file_sync = False,error_only = DEFAULT_ERROR_ONLY,quiet = False):
+						 single_window = DEFAULT_SINGLE_WINDOW,file_sync = False,error_only = DEFAULT_ERROR_ONLY,quiet = False,identity_file = DEFAULT_IDENTITY_FILE):
 	f'''
 	Run the command on the hosts, aka multissh. main function
 
@@ -1515,6 +1543,7 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 		file_sync (bool, optional): Whether to use file sync mode to sync directories. Defaults to {DEFAULT_FILE_SYNC}.
 		error_only (bool, optional): Whether to only print the error output. Defaults to {DEFAULT_ERROR_ONLY}.
 		quiet (bool, optional): Whether to suppress all verbose printout, added for compatibility, avoid using. Defaults to False.
+		identity_file (str, optional): The identity file to use for the ssh connection. Defaults to {DEFAULT_IDENTITY_FILE}.
 
 	Returns:
 		list: A list of Host objects
@@ -1523,6 +1552,7 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 	global __global_suppress_printout
 	global _no_env
 	global _emo
+	global __DEBUG_MODE
 	_emo = False
 	_no_env = no_env
 	if not no_env and '__multiSSH3_UNAVAILABLE_HOSTS' in os.environ:
@@ -1585,6 +1615,8 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 					skipHostStr[i] = userStr + host
 			skipHostStr = ','.join(skipHostStr)
 	targetHostsList = expand_hostnames(frozenset(hostStr.split(',')))
+	if __DEBUG_MODE:
+		eprint(f"Target hosts: {targetHostsList}")
 	skipHostsList = expand_hostnames(frozenset(skipHostStr.split(',')))
 	if skipHostsList:
 		eprint(f"Skipping hosts: {skipHostsList}")
@@ -1614,6 +1646,8 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 			files = []
 		else:
 			files = list(pathSet)
+		if __DEBUG_MODE:
+			eprint(f"Files: {files}")
 	if oneonone:
 		hosts = []
 		if len(commands) != len(targetHostsList) - len(skipHostsList):
@@ -1630,9 +1664,9 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 				continue
 			if host.strip() in skipHostsList: continue
 			if file_sync:
-				hosts.append(Host(host.strip(), os.path.dirname(command)+os.path.sep, files = [command],ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,gatherMode=gather_mode))
+				hosts.append(Host(host.strip(), os.path.dirname(command)+os.path.sep, files = [command],ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,gatherMode=gather_mode,identity_file=identity_file))
 			else:
-				hosts.append(Host(host.strip(), command, files = files,ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,gatherMode=gather_mode))
+				hosts.append(Host(host.strip(), command, files = files,ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,gatherMode=gather_mode,identity_file=identity_file))
 			if not __global_suppress_printout: 
 				eprint(f"Running command: {command} on host: {host}")
 		if not __global_suppress_printout: print('-'*80)
@@ -1656,7 +1690,7 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 				elif ipmi:
 					eprint(f"Error: ipmi mode is not supported in interactive mode")
 				else:
-					hosts.append(Host(host.strip(), '', files = files,ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs))
+					hosts.append(Host(host.strip(), '', files = files,ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,identity_file=identity_file))
 			if not __global_suppress_printout:
 				eprint('-'*80)
 				eprint(f"Running in interactive mode on hosts: {hostStr}" + (f"; skipping: {skipHostStr}" if skipHostStr else ''))
@@ -1674,9 +1708,9 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 					continue
 				if host.strip() in skipHostsList: continue
 				if file_sync:
-					hosts.append(Host(host.strip(), os.path.dirname(command)+os.path.sep, files = [command],ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,gatherMode=gather_mode))
+					hosts.append(Host(host.strip(), os.path.dirname(command)+os.path.sep, files = [command],ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,gatherMode=gather_mode,identity_file=identity_file))
 				else:
-					hosts.append(Host(host.strip(), command, files = files,ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,gatherMode=gather_mode))
+					hosts.append(Host(host.strip(), command, files = files,ipmi=ipmi,interface_ip_prefix=interface_ip_prefix,scp=scp,extraargs=extraargs,gatherMode=gather_mode,identity_file=identity_file))
 			if not __global_suppress_printout and len(commands) > 1:
 				eprint('-'*80)
 				eprint(f"Running command: {command} on hosts: {hostStr}" + (f"; skipping: {skipHostStr}" if skipHostStr else ''))
@@ -1701,6 +1735,9 @@ def get_default_config(args):
 		'DEFAULT_HOSTS': args.hosts,
 		'DEFAULT_USERNAME': args.username,
 		'DEFAULT_PASSWORD': args.password,
+		'DEFAULT_IDENTITY_FILE': args.key if args.key and not os.path.isdir(args.key) else DEFAULT_IDENTITY_FILE,
+		'DEDAULT_SSH_KEY_SEARCH_PATH': args.key if args.key and os.path.isdir(args.key) else DEDAULT_SSH_KEY_SEARCH_PATH,
+		'DEFAULT_USE_KEY': args.use_key,
 		'DEFAULT_EXTRA_ARGS': args.extraargs,
 		'DEFAULT_ONE_ON_ONE': args.oneonone,
 		'DEFAULT_SCP': args.scp,
@@ -1739,6 +1776,26 @@ def write_default_config(args,CONFIG_FILE,backup = True):
 	with open(CONFIG_FILE,'w') as f:
 		json.dump(__configs_from_file,f,indent=4)
 
+def find_ssh_key_file(searchPath = DEDAULT_SSH_KEY_SEARCH_PATH):
+	'''
+	Find the ssh public key file
+
+	Args:
+		searchPath (str, optional): The path to search. Defaults to DEDAULT_SSH_KEY_SEARCH_PATH.
+
+	Returns:
+		str: The path to the ssh key file
+	'''
+	if searchPath:
+		sshKeyPath = searchPath
+	else:
+		sshKeyPath ='~/.ssh'
+	possibleSshKeyFiles = ['id_ed25519','id_ed25519_sk','id_ecdsa','id_ecdsa_sk','id_rsa','id_dsa']
+	for sshKeyFile in possibleSshKeyFiles:
+		if os.path.exists(os.path.expanduser(os.path.join(sshKeyPath,sshKeyFile))):
+			return os.path.join(sshKeyPath,sshKeyFile)
+	return None
+
 
 def main():
 	global _emo
@@ -1748,15 +1805,18 @@ def main():
 	global __ipmiiInterfaceIPPrefix
 	global _binPaths
 	global _env_file
+	global __DEBUG_MODE
 	_emo = False
 	# We handle the signal
 	signal.signal(signal.SIGINT, signal_handler)
 	# We parse the arguments
 	parser = argparse.ArgumentParser(description=f'Run a command on multiple hosts, Use #HOST# or #HOSTNAME# to replace the host name in the command. Config file: {CONFIG_FILE}')
 	parser.add_argument('hosts', metavar='hosts', type=str, nargs='?', help=f'Hosts to run the command on, use "," to seperate hosts. (default: {DEFAULT_HOSTS})',default=DEFAULT_HOSTS)
-	parser.add_argument('commands', metavar='commands', type=str, nargs='+',default=None,help='the command to run on the hosts / the destination of the files #HOST# or #HOSTNAME# will be replaced with the host name.')
+	parser.add_argument('commands', metavar='commands', type=str, nargs='*',default=None,help='the command to run on the hosts / the destination of the files #HOST# or #HOSTNAME# will be replaced with the host name.')
 	parser.add_argument('-u','--username', type=str,help=f'The general username to use to connect to the hosts. Will get overwrote by individual username@host if specified. (default: {DEFAULT_USERNAME})',default=DEFAULT_USERNAME)
 	parser.add_argument('-p', '--password', type=str,help=f'The password to use to connect to the hosts, (default: {DEFAULT_PASSWORD})',default=DEFAULT_PASSWORD)
+	parser.add_argument('-k','--key','--identity',nargs='?', type=str,help=f'The identity file to use to connect to the hosts. Implies --use_key. Specify a folder for program to search for a key. Use option without value to use {DEDAULT_SSH_KEY_SEARCH_PATH} (default: {DEFAULT_IDENTITY_FILE})',const=DEDAULT_SSH_KEY_SEARCH_PATH,default=DEFAULT_IDENTITY_FILE)
+	parser.add_argument('-uk','--use_key', action='store_true', help=f'Attempt to use public key file to connect to the hosts. (default: {DEFAULT_USE_KEY})', default=DEFAULT_USE_KEY)
 	parser.add_argument('-ea','--extraargs',type=str,help=f'Extra arguments to pass to the ssh / rsync / scp command. Put in one string for multiple arguments.Use "=" ! Ex. -ea="--delete" (default: {DEFAULT_EXTRA_ARGS})',default=DEFAULT_EXTRA_ARGS)
 	parser.add_argument("-11",'--oneonone', action='store_true', help=f"Run one corresponding command on each host. (default: {DEFAULT_ONE_ON_ONE})", default=DEFAULT_ONE_ON_ONE)
 	parser.add_argument("-f","--file", action='append', help="The file to be copied to the hosts. Use -f multiple times to copy multiple files")
@@ -1785,11 +1845,26 @@ def main():
 	parser.add_argument("-su","--skip_unreachable", action='store_true', help=f"Skip unreachable hosts while using --repeat. Note: Timedout Hosts are considered unreachable. Note: multiple command sequence will still auto skip unreachable hosts. (default: {DEFAULT_SKIP_UNREACHABLE})", default=DEFAULT_SKIP_UNREACHABLE)
 	parser.add_argument("-sh","--skip_hosts", type=str, help=f"Skip the hosts in the list. (default: {DEFAULT_SKIP_HOSTS if DEFAULT_SKIP_HOSTS else 'None'})", default=DEFAULT_SKIP_HOSTS)
 	parser.add_argument('--store_config_file', action='store_true', help=f'Store / generate the default config file from command line argument and current config at {CONFIG_FILE}')
+	parser.add_argument('--debug', action='store_true', help='Print debug information')
+	parser.add_argument('--copy-id', action='store_true', help='Copy the ssh id to the hosts')
 	parser.add_argument("-V","--version", action='version', version=f'%(prog)s {version} with [ {", ".join(_binPaths.keys())} ] by {AUTHOR} ({AUTHOR_EMAIL})')
 	
 	# parser.add_argument('-u', '--user', metavar='user', type=str, nargs=1,
 	#                     help='the user to use to connect to the hosts')
-	args = parser.parse_args()
+	#args = parser.parse_args()
+
+	# if python version is 3.7 or higher, use parse_intermixed_args
+	if sys.version_info >= (3,7):
+		args = parser.parse_intermixed_args()
+	else:
+		# try to parse the arguments using parse_known_args
+		args, unknown = parser.parse_known_args()
+		# if there are unknown arguments, we will try to parse them again using parse_args
+		if unknown:
+			eprint(f"Warning: Unknown arguments, treating all as commands: {unknown}")
+			args.commands += unknown
+			
+			
 
 	if args.store_config_file:
 		try:
@@ -1810,12 +1885,15 @@ def main():
 				eprint(f"Config file written to {CONFIG_FILE}")
 		except Exception as e:
 			eprint(f"Error while writing config file: {e}")
+			import traceback
+			eprint(traceback.format_exc())
 		if not args.commands:
 			with open(CONFIG_FILE,'r') as f:
 				eprint(f"Config file content: \n{f.read()}")
 			sys.exit(0)
 
 	_env_file = args.env_file
+	__DEBUG_MODE = args.debug
 	# if there are more than 1 commands, and every command only consists of one word,
 	# we will ask the user to confirm if they want to run multiple commands or just one command.
 	if not args.file and len(args.commands) > 1 and all([len(command.split()) == 1 for command in args.commands]):
@@ -1831,7 +1909,35 @@ def main():
 			eprint(f"\nRunning multiple commands: {', '.join(args.commands)} on all hosts")
 		else:
 			sys.exit(0)
-	
+
+	if args.key or args.use_key:
+		if not args.key:
+			args.key = find_ssh_key_file()
+		else:
+			if os.path.isdir(os.path.expanduser(args.key)):
+				args.key = find_ssh_key_file(args.key)
+			elif not os.path.exists(args.key):
+				eprint(f"Warning: Identity file {args.key} not found. Passing to ssh anyway. Proceed with caution.")
+
+	if args.copy_id:
+		if 'ssh-copy-id' in _binPaths:
+			# we will copy the id to the hosts
+			for host in formHostStr(args.hosts).split(','):
+				command = f"{_binPaths['ssh-copy-id']} "
+				if args.key:
+					command = f"{command}-i {args.key} "
+				if args.username:
+					command =  f"{command} {args.username}@"
+				command = f"{command}{host}"
+				if args.password and 'sshpass' in _binPaths:
+					command = f"{_binPaths['sshpass']} -p {args.password} {command}"
+				eprint(f"> {command}")
+				os.system(command)
+		else:
+			eprint(f"Warning: ssh-copy-id not found in {_binPaths} , skipping copy id to the hosts")
+		if not args.commands:
+			sys.exit(0)
+
 	__ipmiiInterfaceIPPrefix = args.ipmi_interface_ip_prefix
 
 	if not args.greppable and not args.json and not args.no_output:
@@ -1842,7 +1948,7 @@ def main():
 						 nowatch=args.nowatch,json=args.json,called=args.no_output,max_connections=args.max_connections,
 						 files=args.file,file_sync=args.file_sync,ipmi=args.ipmi,interface_ip_prefix=args.interface_ip_prefix,scp=args.scp,gather_mode = args.gather_mode,username=args.username,
 						 extraargs=args.extraargs,skipUnreachable=args.skip_unreachable,no_env=args.no_env,greppable=args.greppable,skip_hosts = args.skip_hosts,
-						 curses_min_char_len = args.window_width, curses_min_line_len = args.window_height,single_window=args.single_window,error_only=args.error_only))
+						 curses_min_char_len = args.window_width, curses_min_line_len = args.window_height,single_window=args.single_window,error_only=args.error_only,identity_file=args.key))
 	if args.error_only:
 		__global_suppress_printout = True
 
@@ -1857,7 +1963,7 @@ def main():
 							 nowatch=args.nowatch,json=args.json,called=args.no_output,max_connections=args.max_connections,
 							 files=args.file,file_sync=args.file_sync,ipmi=args.ipmi,interface_ip_prefix=args.interface_ip_prefix,scp=args.scp,gather_mode = args.gather_mode,username=args.username,
 							 extraargs=args.extraargs,skipUnreachable=args.skip_unreachable,no_env=args.no_env,greppable=args.greppable,skip_hosts = args.skip_hosts,
-							 curses_min_char_len = args.window_width, curses_min_line_len = args.window_height,single_window=args.single_window,error_only=args.error_only)
+							 curses_min_char_len = args.window_width, curses_min_line_len = args.window_height,single_window=args.single_window,error_only=args.error_only,identity_file=args.key)
 		#print('*'*80)
 
 		if not __global_suppress_printout: eprint('-'*80)

multiSSH3-4.97.dist-info/RECORD

@@ -1,7 +0,0 @@
-multiSSH3.py,sha256=WCp2vui9NMeviCPe39CVu9WY0-lOn3YEIzFGO8i8m7o,91417
-multiSSH3-4.97.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-multiSSH3-4.97.dist-info/METADATA,sha256=ndgCxl2LHcQ3x88vqxJhTOd6ah7U46-Xva-Uj74oBzU,16043
-multiSSH3-4.97.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-multiSSH3-4.97.dist-info/entry_points.txt,sha256=xi2rWWNfmHx6gS8Mmx0rZL2KZz6XWBYP3DWBpWAnnZ0,143
-multiSSH3-4.97.dist-info/top_level.txt,sha256=tUwttxlnpLkZorSsroIprNo41lYSxjd2ASuL8-EJIJw,10
-multiSSH3-4.97.dist-info/RECORD,,