l.s.BaseSSHClient(object) : class documentation

Part of libcloud.ssh View Source View In Hierarchy

Known subclasses: libcloud.ssh.ParamikoSSHClient, libcloud.ssh.ShellOutSSHClient

Base class representing a connection over SSH/SCP to a remote node.

Method	__init__
Method	connect	Connect to the remote node over SSH.
Method	put	Upload a file to the remote node.
Method	delete	Delete/Unlink a file on the remote node.
Method	run	Run a command on a remote node.
Method	close	Shutdown connection to the remote node.

def __init__(self, hostname, port=22, username='root', password=None, key=None): (source)

overridden in libcloud.ssh.ParamikoSSHClient

Parameters	hostname	Hostname or IP address to connect to. (type: `str`)
	port	TCP port to communicate on, defaults to 22. (type: `int`)
	username	Username to use, defaults to root. (type: `str`)
	password	Password to authenticate with. (type: `str`)
	key	Private SSH keys to authenticate with. (type: `list`)

def connect(self): (source)

overridden in libcloud.ssh.ParamikoSSHClient

Connect to the remote node over SSH.

Returns bool

def put(self, path, contents=None, chmod=None): (source)

overridden in libcloud.ssh.ParamikoSSHClient

Upload a file to the remote node.

Parameters	path	File path on the remote node. (type: `str`)
	contents	File Contents. (type: `str`)
	chmod	chmod file to this after creation. (type: `int`)

def delete(self, path): (source)

overridden in libcloud.ssh.ParamikoSSHClient

Delete/Unlink a file on the remote node.

Parameters path File path on the remote node. (type: str)

def run(self, cmd): (source)

overridden in libcloud.ssh.ParamikoSSHClient

Run a command on a remote node.

Parameters cmd Command to run. (type: str)

def close(self): (source)

overridden in libcloud.ssh.ParamikoSSHClient

Shutdown connection to the remote node.

API Documentation for libcloud, generated by pydoctor at 2012-07-15 18:42:22.