Timeout in paramiko (python)

Question

I'm looking for a way to set a timeout for this:

transport = paramiko.Transport((host, port))
transport.connect(username = username, password = password)
sftp = paramiko.SFTPClient.from_transport(transport)
sftp.get(remotepath, localpath)
sftp.close()
transport.close()

Solution

The connection timeout can be set with the timeout parameter (that indicated the number of seconds for the time out as described here) of the connect function.

ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
ssh.connect(host, username=username, password=password, timeout=10)
sftp = ssh.open_sftp()
sftp.get(remotepath, localpath)
sftp.close()

Comments

[manoj prashant k]

@kukosk It would help if you mentioned the unit in which timeout is to be given, I guess its seconds.

[jxramos]

What's the default timeout, I don't think I found it mentioned in the docs either, although they do mention timeout (float) – an optional timeout (in seconds) for the TCP connect

[jxramos]

Here's some more background, if timeout is not specified the client falls into blocking mode: docs.python.org/3/library/socket.html#socket-timeouts

[jxramos]

Lots of default timeout definitions pop up at github.com/jbouse-debian/paramiko/blob/master/paramiko/…, all given in seconds

[trozen]

Note that timeout parameter sets TCP timeout. There are also banner_timeout and auth_timeout which you may want to adjust as well.

[chrisinmtown]

@jxramos are you sure about blocking behavior? When I tested an unreachable address with no timeout argument, the connect timed out after 75 seconds.