starcluster.ssh.Connection

Class Connection

Establishes an ssh connection to a remote host using either password or private key authentication. Once established, this object allows executing and copying files to/from the remote host

Instance Methods

[hide private]

__init__(self, host, username=None, password=None, private_key=None, private_key_pass=None, port=22, timeout=30)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

_get_socket(self, hostname, port)

source code

_load_rsa_key(self, private_key, private_key_pass=None)

source code

_load_dsa_key(self, private_key, private_key_pass=None)

source code

_sftp_connect(self)
Establish the SFTP connection.

source code

remote_file(self, file, mode='w')
Returns a remote file descriptor source code

path_exists(self, path)
Test whether a remote path exists.

source code

ls(self, path)
Return a list containing the names of the entries in the remote path.

source code

isdir(self, path)
Return true if the remote path refers to an existing directory.

source code

isfile(self, path)
Return true if the remote path refers to an existing file.

source code

stat(self, path)
Perform a stat system call on the given remote path.

source code

get(self, remotepath, localpath=None)
Copies a file between the remote host and the local host.

source code

put(self, localpath, remotepath=None)
Copies a file between the local host and the remote host.

source code

execute_async(self, command)
Executes a remote command without blocking

source code

execute(self, command, silent=True, only_printable=False, ignore_exit_status=False)
Execute a remote command and return stdout/stderr

source code

close(self)
Closes the connection and cleans up.

source code

interactive_shell(self)

source code

_posix_shell(self, chan)

source code

_windows_shell(self, chan)

source code

__del__(self)
Attempt to clean up if not explicitly closed.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

init(self, host, username=None, password=None, private_key=None, private_key_pass=None, port=22, timeout=30)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

path_exists(self, path)

source code

Test whether a remote path exists. Returns False for broken symbolic links

execute_async(self, command)

source code

Executes a remote command without blocking

NOTE: this method will not block, however, if your process does not complete or background itself before the python process executing this code exits, it will not persist on the remote machine

execute(self, command, silent=True, only_printable=False, ignore_exit_status=False)

source code


Execute a remote command and return stdout/stderr

NOTE: this function blocks until the process finishes

kwargs:
silent - do not print output
only_printable - filter the command's output to allow only printable
                characters
returns List of output lines

Class Connection

__init__(self, host, username=None, password=None, private_key=None, private_key_pass=None, port=22, timeout=30) (Constructor)

path_exists(self, path)

execute_async(self, command)

execute(self, command, silent=True, only_printable=False, ignore_exit_status=False)

init(self, host, username=None, password=None, private_key=None, private_key_pass=None, port=22, timeout=30)
(Constructor)