The sshutil.host Module

class sshutil.host.Host(server=None, port=22, cwd=None, username=None, password=None, debug=False, cache=None, proxycmd=None)

Bases: object

A Host object is either local (shell) or remote host (ssh) and provides easy access to the given host for running commands etc.

copy_to(localfile, remotefile)
run(command)

Run a command, return stdout.

Returns:stdout
Raises:CalledProcessError
run_status(command)

Run a command, return exitcode and stdout.

Returns:(status, stdout)
run_status_stderr(command)

Run the command returning exit code, stdout and stderr.

Returns:(returncode, stdout, stderr)
>>> host = Host()
>>> status, output, error = host.run_status_stderr("ls -d /etc")
>>> status
0
>>> print(output, end="")
/etc
>>> print(error, end="")
>>> status, output, error = host.run_status_stderr("grep foobar doesnt-exist")
>>> status
2
>>> print(output, end="")
>>>
>>> print(error, end="")
grep: doesnt-exist: No such file or directory
run_stderr(command)

Run a command, return stdout and stderr,

Returns:(stdout, stderr)
Raises:CalledProcessError