Added extra paramiko keyword argument passing from parallel and single host SSH clients. Updated docstrings. Added test for paramiko extra argument passing from parallel client

Author: Dan

pssh/pssh_client.py

@@ -369,7 +369,7 @@ def __init__(self, hosts, user=None, password=None, port=None, pkey=None,
 
     def run_command(self, command, sudo=False, user=None, stop_on_errors=True,
                     shell=None, use_shell=True, use_pty=True, host_args=None,
-                    encoding='utf-8'):
+                    encoding='utf-8', **paramiko_kwargs):
         """Run command on all hosts in parallel, honoring self.pool_size,
         and return output buffers.
 
@@ -420,6 +420,9 @@ def run_command(self, command, sudo=False, user=None, stop_on_errors=True,
         :param encoding: Encoding to use for output. Must be valid
             `Python codec <https://docs.python.org/2.7/library/codecs.html>`_
         :type encoding: str
+        :param paramiko_kwargs: (Optional) Extra keyword arguments to be
+          passed on to :py:func:`paramiko.client.SSHClient.connect`
+        :type paramiko_kwargs: dict
 
         :rtype: Dictionary with host as key and
           :py:class:`pssh.output.HostOutput` as value as per
@@ -667,7 +670,8 @@ def run_command(self, command, sudo=False, user=None, stop_on_errors=True,
                 cmds = [self.pool.spawn(self._exec_command, host,
                                         command % host_args[host_i],
                                         sudo=sudo, user=user, shell=shell,
-                                        use_shell=use_shell, use_pty=use_pty)
+                                        use_shell=use_shell, use_pty=use_pty,
+                                        **paramiko_kwargs)
                         for host_i, host in enumerate(self.hosts)]
             except IndexError:
                 raise HostArgumentException(
@@ -677,7 +681,8 @@ def run_command(self, command, sudo=False, user=None, stop_on_errors=True,
             cmds = [self.pool.spawn(
                 self._exec_command, host, command,
                 sudo=sudo, user=user, shell=shell,
-                use_shell=use_shell, use_pty=use_pty)
+                use_shell=use_shell, use_pty=use_pty,
+                **paramiko_kwargs)
                 for host in self.hosts]
         for cmd in cmds:
             try:
@@ -696,7 +701,8 @@ def _get_host_config_values(self, host):
         return _user, _port, _password, _pkey
 
     def _exec_command(self, host, command, sudo=False, user=None,
-                      shell=None, use_shell=True, use_pty=True):
+                      shell=None, use_shell=True, use_pty=True,
+                      **paramiko_kwargs):
         """Make SSHClient, run command on host"""
         if host not in self.host_clients or self.host_clients[host] is None:
             _user, _port, _password, _pkey = self._get_host_config_values(host)
@@ -708,7 +714,8 @@ def _exec_command(self, host, command, sudo=False, user=None,
                 proxy_host=self.proxy_host, proxy_port=self.proxy_port,
                 proxy_user=self.proxy_user, proxy_password=self.proxy_password,
                 proxy_pkey=self.proxy_pkey, allow_agent=self.allow_agent,
-                agent=self.agent, channel_timeout=self.channel_timeout)
+                agent=self.agent, channel_timeout=self.channel_timeout,
+                **paramiko_kwargs)
         return self.host_clients[host].exec_command(
             command, sudo=sudo, user=user, shell=shell,
             use_shell=use_shell, use_pty=use_pty)

pssh/ssh_client.py

@@ -48,7 +48,8 @@ def __init__(self, host,
                  allow_agent=True, timeout=10, proxy_host=None,
                  proxy_port=22, proxy_user=None, proxy_password=None,
                  proxy_pkey=None, channel_timeout=None,
-                 _openssh_config_file=None):
+                 _openssh_config_file=None,
+                 **paramiko_kwargs):
         """
         :param host: Hostname to connect to
         :type host: str
@@ -95,6 +96,9 @@ def __init__(self, host,
         :param allow_agent: (Optional) set to False to disable connecting to
           the SSH agent
         :type allow_agent: bool
+        :param paramiko_kwargs: (Optional) Extra keyword arguments to be
+          passed on to :py:func:`paramiko.client.SSHClient.connect`
+        :type paramiko_kwargs: dict
         """
         try:
             host, _user, _port, _pkey = read_openssh_config(
@@ -125,11 +129,11 @@ def __init__(self, host,
             logger.debug(
                 "Proxy configured for destination host %s - Proxy host: %s:%s",
                 self.host, self.proxy_host, self.proxy_port,)
-            self._connect_tunnel()
+            self._connect_tunnel(**paramiko_kwargs)
         else:
-            self._connect(self.client, self.host, self.port)
+            self._connect(self.client, self.host, self.port, **paramiko_kwargs)
 
-    def _connect_tunnel(self):
+    def _connect_tunnel(self, **paramiko_kwargs):
         """Connects to SSH server via an intermediate SSH tunnel server.
         client (me) -> tunnel (ssh server to proxy through) ->
         ``self.host`` (ssh server to run command)
@@ -142,7 +146,7 @@ def _connect_tunnel(self):
             paramiko.MissingHostKeyPolicy())
         self._connect(self.proxy_client, self.proxy_host, self.proxy_port,
                       user=self.proxy_user, password=self.proxy_password,
-                      pkey=self.proxy_pkey)
+                      pkey=self.proxy_pkey, **paramiko_kwargs)
         logger.info("Connecting via SSH proxy %s:%s -> %s:%s", self.proxy_host,
                     self.proxy_port, self.host, self.port,)
         try:
@@ -151,15 +155,17 @@ def _connect_tunnel(self):
                 timeout=self.timeout)
             sleep(0)
             return self._connect(self.client, self.host, self.port,
-                                 sock=proxy_channel)
+                                 sock=proxy_channel,
+                                 **paramiko_kwargs)
         except (ChannelException, paramiko.SSHException) as ex:
             error_type = ex.args[1] if len(ex.args) > 1 else ex.args[0]
             raise ConnectionErrorException(
                 "Error connecting to host '%s:%s' - %s",
                 self.host, self.port, str(error_type))
 
     def _connect(self, client, host, port, sock=None, retries=1,
-                 user=None, password=None, pkey=None):
+                 user=None, password=None, pkey=None,
+                 **paramiko_kwargs):
         """Connect to host
 
         :raises: :py:class:`pssh.exceptions.AuthenticationException`
@@ -172,18 +178,22 @@ def _connect(self, client, host, port, sock=None, retries=1,
           SSH errors
         """
         try:
-            client.connect(host, username=user if user else self.user,
+            client.connect(host,
+                           username=user if user else self.user,
                            password=password if password else self.password,
                            port=port, pkey=pkey if pkey else self.pkey,
                            sock=sock, timeout=self.timeout,
-                           allow_agent=self.allow_agent)
+                           allow_agent=self.allow_agent,
+                           **paramiko_kwargs)
         except sock_gaierror as ex:
             logger.error("Could not resolve host '%s' - retry %s/%s",
                          host, retries, self.num_retries)
             while retries < self.num_retries:
                 sleep(5)
-                return self._connect(client, host, port, sock=sock,
-                                     retries=retries+1)
+                return self._connect(client, host, port,
+                                     sock=sock,
+                                     retries=retries+1,
+                                     **paramiko_kwargs)
             raise UnknownHostException("Unknown host %s - %s - retry %s/%s",
                                        host, str(ex.args[1]), retries,
                                        self.num_retries)
@@ -192,8 +202,10 @@ def _connect(self, client, host, port, sock=None, retries=1,
                          self.host, self.port, retries, self.num_retries)
             while retries < self.num_retries:
                 sleep(5)
-                return self._connect(client, host, port, sock=sock,
-                                     retries=retries+1)
+                return self._connect(client, host, port,
+                                     sock=sock,
+                                     retries=retries+1,
+                                     **paramiko_kwargs)
             error_type = ex.args[1] if len(ex.args) > 1 else ex.args[0]
             raise ConnectionErrorException(
                 "Error connecting to host '%s:%s' - %s - retry %s/%s",
@@ -234,9 +246,6 @@ def exec_command(self, command, sudo=False, user=None,
           being where a shell is not used and/or stdout/stderr/stdin buffers
           are not required. Defaults to ``True``
         :type use_pty: bool
-        :param kwargs: (Optional) Keyword arguments to be passed to remote
-          command
-        :type kwargs: dict
         :rtype: Tuple of `(channel, hostname, stdout, stderr, stdin)`.
           Channel is the remote SSH channel, needed to ensure all of stdout has
           been got, hostname is remote hostname the copy is to, stdout and

requirements_dev.txt

@@ -3,4 +3,5 @@ flake8
 sphinx
 sphinx_rtd_theme
 nose
+python-gssapi
 -e .

tests/test_pssh_client.py

@@ -1051,6 +1051,12 @@ def test_run_command_no_shell(self):
         self.assertTrue(len(stdout) > 0)
         self.assertTrue(output[self.host].exit_code == 0)
 
+    def test_extra_paramiko_args(self):
+        output = self.client.run_command('id', gss_auth=True, gss_kex=True,
+                                         gss_host='gss_host')
+        trans = self.client.host_clients[self.host].client.get_transport()
+        self.assertEqual(trans.gss_host, 'gss_host')
+
     def test_proxy_remote_host_failure_timeout(self):
         """Test that timeout setting is passed on to proxy to be used for the
         proxy->remote host connection timeout