Skip to content

Commit 9afc944

Browse files
author
Dan
committed
Updated docstrings. Updated readme
1 parent acf13ee commit 9afc944

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ parallel-ssh uses asychronous network requests - there is *no* multi-threading o
77

88
This is a *requirement* for commands on many (hundreds/thousands/hundreds of thousands) of hosts which would grind a system to a halt simply by having so many processes/threads all wanting to execute if done with multi-threading/processing.
99

10+
.. image:: https://img.shields.io/pypi/v/parallel-ssh.svg
11+
:target: https://pypi.python.org/pypi/parallel-ssh
12+
:alt: Latest Version
1013
.. image:: https://travis-ci.org/pkittenis/parallel-ssh.svg?branch=master
1114
:target: https://travis-ci.org/pkittenis/parallel-ssh
1215
.. image:: https://coveralls.io/repos/pkittenis/parallel-ssh/badge.png?branch=master

pssh.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ def __init__(self, hosts,
431431
# To hold host clients
432432
self.host_clients = dict((host, None) for host in hosts)
433433

434-
def run_command(self, *args, **kwargs):
434+
def run_command(self, *args, sudo=False, **kwargs):
435435
"""Run command on all hosts in parallel, honoring self.pool_size,
436436
and return output buffers.
437437
@@ -441,6 +441,8 @@ def run_command(self, *args, **kwargs):
441441
442442
:param args: Positional arguments for command
443443
:type args: tuple
444+
:param sudo: (Optional) Run with sudo. Defaults to False
445+
:type sudo: bool
444446
:param kwargs: Keyword arguments for command
445447
:type kwargs: dict
446448

0 commit comments

Comments
 (0)