Skip to content

Commit

Permalink
Updated docstrings. Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Dan committed Aug 11, 2015
1 parent acf13ee commit 9afc944
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ parallel-ssh uses asychronous network requests - there is *no* multi-threading o

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.

.. image:: https://img.shields.io/pypi/v/parallel-ssh.svg
:target: https://pypi.python.org/pypi/parallel-ssh
:alt: Latest Version
.. image:: https://travis-ci.org/pkittenis/parallel-ssh.svg?branch=master
:target: https://travis-ci.org/pkittenis/parallel-ssh
.. image:: https://coveralls.io/repos/pkittenis/parallel-ssh/badge.png?branch=master
Expand Down
4 changes: 3 additions & 1 deletion pssh.py
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ def __init__(self, hosts,
# To hold host clients
self.host_clients = dict((host, None) for host in hosts)

def run_command(self, *args, **kwargs):
def run_command(self, *args, sudo=False, **kwargs):
"""Run command on all hosts in parallel, honoring self.pool_size,
and return output buffers.
Expand All @@ -441,6 +441,8 @@ def run_command(self, *args, **kwargs):
:param args: Positional arguments for command
:type args: tuple
:param sudo: (Optional) Run with sudo. Defaults to False
:type sudo: bool
:param kwargs: Keyword arguments for command
:type kwargs: dict
Expand Down

0 comments on commit 9afc944

Please sign in to comment.