Skip to content

Commit 4ef7f26

Browse files
committed
+docs for timeout
1 parent 77c1242 commit 4ef7f26

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

pssh.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,9 @@ def __init__(self, host,
9494
:param num_retries: (Optional) Number of retries for connection attempts\
9595
before the client gives up. Defaults to 3.
9696
:type num_retries: int
97+
:param timeout: (Optional) Number of seconds to timout connection attempts\
98+
before the client gives up. Defaults to 10.
99+
:type timeout: int
97100
:param forward_ssh_agent: (Optional) Turn on SSH agent forwarding - \
98101
equivalent to `ssh -A` from the `ssh` command line utility. \
99102
Defaults to True if not set.
@@ -301,6 +304,9 @@ def __init__(self, hosts,
301304
:param num_retries: (Optional) Number of retries for connection attempts\
302305
before the client gives up. Defaults to 3.
303306
:type num_retries: int
307+
:param timeout: (Optional) Number of seconds to timout connection attempts\
308+
before the client gives up. Defaults to 10.
309+
:type timeout: int
304310
:param forward_ssh_agent: (Optional) Turn on SSH agent forwarding - \
305311
equivalent to `ssh -A` from the `ssh` command line utility. \
306312
Defaults to True if not set.

0 commit comments

Comments
 (0)