From ed280d5ac360e2af796e9bd973d7b4df89f0c449 Mon Sep 17 00:00:00 2001 From: "Jeremy T. Bouse" Date: Fri, 27 Nov 2009 16:20:12 -0500 Subject: Imported Upstream version 1.7.4 --- docs/paramiko.SSHClient-class.html | 839 +++++++++++++++++++++++++++++++++++++ 1 file changed, 839 insertions(+) create mode 100644 docs/paramiko.SSHClient-class.html (limited to 'docs/paramiko.SSHClient-class.html') diff --git a/docs/paramiko.SSHClient-class.html b/docs/paramiko.SSHClient-class.html new file mode 100644 index 0000000..4e3ec8e --- /dev/null +++ b/docs/paramiko.SSHClient-class.html @@ -0,0 +1,839 @@ + + + + + paramiko.SSHClient + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package paramiko :: + Class SSHClient + + + + + +
[frames] | no frames]
+
+ +

Class SSHClient

source code

+
+object --+
+         |
+        SSHClient
+
+ +
+

A high-level representation of a session with an SSH server. This + class wraps Transport, Channel, and SFTPClient to take care of most aspects of + authenticating and opening channels. A typical use case is:

+
+   client = SSHClient()
+   client.load_system_host_keys()
+   client.connect('ssh.example.com')
+   stdin, stdout, stderr = client.exec_command('ls -l')
+
+

You may pass in explicit overrides for authentication and server host + key checking. The default mechanism is to try to use local key files or + an SSH agent (if one is running).

+ +
+

Since: + 1.6 +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Instance Methods
+   + + + + + + +
__init__(self)
+ Create a new SSHClient.		 + source code + +
+ +
+   + + + + + + +
close(self)
+ Close this SSHClient and its underlying Transport.		 + source code + +
+ +
+   + + + + + + +
connect(self, + hostname, + port=22, + username=None, + password=None, + pkey=None, + key_filename=None, + timeout=None, + allow_agent=True, + look_for_keys=True)
+ Connect to an SSH server and authenticate to it.		 + source code + +
+ +
+ tuple(ChannelFile, ChannelFile, ChannelFile) + + + + + + +
exec_command(self, + command, + bufsize=-1)
+ Execute a command on the SSH server.		 + source code + +
+ +
+ HostKeys + + + + + + +
get_host_keys(self)
+ Get the local HostKeys object.		 + source code + +
+ +
+ Transport + + + + + + +
get_transport(self)
+ Return the underlying Transport object for this SSH connection.		 + source code + +
+ +
+ Channel + + + + + + +
invoke_shell(self, + term='vt100', + width=80, + height=24)
+ Start an interactive shell session on the SSH server.		 + source code + +
+ +
+   + + + + + + +
load_host_keys(self, + filename)
+ Load host keys from a local host-key file.		 + source code + +
+ +
+   + + + + + + +
load_system_host_keys(self, + filename=None)
+ Load host keys from a system (read-only) file.		 + source code + +
+ +
+ SFTPClient + + + + + + +
open_sftp(self)
+ Open an SFTP session on the SSH server.		 + source code + +
+ +
+   + + + + + + +
save_host_keys(self, + filename)
+ Save the host keys back to a file.		 + source code + +
+ +
+   + + + + + + +
set_log_channel(self, + name)
+ Set the channel for logging.		 + source code + +
+ +
+   + + + + + + +
set_missing_host_key_policy(self, + policy)
+ Set the policy to use when connecting to a server that doesn't have a + host key in either the system or local HostKeys + objects.		 + source code + +
+ +
+

Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

+
+ + + + + + + + + +
+ Properties
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ Method Details
+ +
+ +
+ + +
+

__init__(self) +
(Constructor) +

+ 		source code  +
+ +

Create a new SSHClient.

+
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

connect(self, + hostname, + port=22, + username=None, + password=None, + pkey=None, + key_filename=None, + timeout=None, + allow_agent=True, + look_for_keys=True) +

+ 		source code  +
+ +

Connect to an SSH server and authenticate to it. The server's host + key is checked against the system host keys (see load_system_host_keys) and any local host keys (load_host_keys). If the server's hostname is not found + in either set of host keys, the missing host key policy is used (see set_missing_host_key_policy). The default policy is to + reject the key and raise an SSHException.

+

Authentication is attempted in the following order of priority:

+
    +
  • + The pkey or key_filename passed in (if any) +
    • +
  • + Any key we can find through an SSH agent +
    • +
  • + Any "id_rsa" or "id_dsa" key discoverable in + ~/.ssh/ +
    • +
  • + Plain username/password auth, if a password was given +
    • +
+

If a private key requires a password to unlock it, and a password is + passed in, that password will be used to attempt to unlock the key.

+
+
Parameters:
+
    +
  • hostname (str) - the server to connect to
    • +
  • port (int) - the server port to connect to
    • +
  • username (str) - the username to authenticate as (defaults to the current local + username)
    • +
  • password (str) - a password to use for authentication or for unlocking a private + key
    • +
  • pkey (PKey) - an optional private key to use for authentication
    • +
  • key_filename (str or list(str)) - the filename, or list of filenames, of optional private key(s) to + try for authentication
    • +
  • timeout (float) - an optional timeout (in seconds) for the TCP connect
    • +
  • allow_agent (bool) - set to False to disable connecting to the SSH agent
    • +
  • look_for_keys (bool) - set to False to disable searching for discoverable private key + files in ~/.ssh/
    • +
+
Raises:
+
    +
  • BadHostKeyException - if the server's host key could not be verified
    • +
  • AuthenticationException - if authentication failed
    • +
  • SSHException - if there was any other error connecting or establishing an SSH + session
    • +
  • socket.error - if a socket error occurred while connecting
    • +
+
+
+
+ +
+ +
+ + +
+

exec_command(self, + command, + bufsize=-1) +

+ 		source code  +
+ +

Execute a command on the SSH server. A new Channel is opened and + the requested command is executed. The command's input and output + streams are returned as python file-like objects + representing stdin, stdout, and stderr.

+
+
Parameters:
+
    +
  • command (str) - the command to execute
    • +
  • bufsize (int) - interpreted the same way as by the built-in file() + function in python
    • +
+
Returns: tuple(ChannelFile, ChannelFile, ChannelFile)
+
the stdin, stdout, and stderr of the executing command
+
Raises:
+
    +
  • SSHException - if the server fails to execute the command
    • +
+
+
+
+ +
+ +
+ + +
+

get_host_keys(self) +

+ 		source code  +
+ +

Get the local HostKeys object. This can be used to examine the local + host keys or change them.

+
+
Returns: HostKeys
+
the local host keys
+
+
+
+ +
+ +
+ + +
+

get_transport(self) +

+ 		source code  +
+ +

Return the underlying Transport object for this SSH connection. This can be + used to perform lower-level tasks, like opening specific kinds of + channels.

+
+
Returns: Transport
+
the Transport for this connection
+
+
+
+ +
+ +
+ + +
+

invoke_shell(self, + term='vt100', + width=80, + height=24) +

+ 		source code  +
+ +

Start an interactive shell session on the SSH server. A new Channel is opened and + connected to a pseudo-terminal using the requested terminal type and + size.

+
+
Parameters:
+
    +
  • term (str) - the terminal type to emulate (for example, + "vt100")
    • +
  • width (int) - the width (in characters) of the terminal window
    • +
  • height (int) - the height (in characters) of the terminal window
    • +
+
Returns: Channel
+
a new channel connected to the remote shell
+
Raises:
+
+
+
+
+ +
+ +
+ + +
+

load_host_keys(self, + filename) +

+ 		source code  +
+ +

Load host keys from a local host-key file. Host keys read with this + method will be checked after keys loaded via load_system_host_keys, but will be saved back by save_host_keys (so they can be modified). The missing + host key policy AutoAddPolicy adds keys to this set and saves them, when + connecting to a previously-unknown server.

+

This method can be called multiple times. Each new set of host keys + will be merged with the existing set (new replacing old if there are + conflicts). When automatically saving, the last hostname is used.

+
+
Parameters:
+
    +
  • filename (str) - the filename to read
    • +
+
Raises:
+
    +
  • IOError - if the filename could not be read
    • +
+
+
+
+ +
+ +
+ + +
+

load_system_host_keys(self, + filename=None) +

+ 		source code  +
+ +

Load host keys from a system (read-only) file. Host keys read with + this method will not be saved back by save_host_keys.

+

This method can be called multiple times. Each new set of host keys + will be merged with the existing set (new replacing old if there are + conflicts).

+

If filename is left as None, an attempt will + be made to read keys from the user's local "known hosts" file, + as used by OpenSSH, and no exception will be raised if the file can't be + read. This is probably only useful on posix.

+
+
Parameters:
+
    +
  • filename (str) - the filename to read, or None
    • +
+
Raises:
+
    +
  • IOError - if a filename was provided and the file could not be read
    • +
+
+
+
+ +
+ +
+ + +
+

open_sftp(self) +

+ 		source code  +
+ +

Open an SFTP session on the SSH server.

+
+
Returns: SFTPClient
+
a new SFTP session object
+
+
+
+ +
+ +
+ + +
+

save_host_keys(self, + filename) +

+ 		source code  +
+ +

Save the host keys back to a file. Only the host keys loaded with load_host_keys (plus any added directly) will be saved + -- not any host keys loaded with load_system_host_keys.

+
+
Parameters:
+
    +
  • filename (str) - the filename to save to
    • +
+
Raises:
+
    +
  • IOError - if the file could not be written
    • +
+
+
+
+ +
+ +
+ + +
+

set_log_channel(self, + name) +

+ 		source code  +
+ +

Set the channel for logging. The default is + "paramiko.transport" but it can be set to anything + you want.

+
+
Parameters:
+
    +
  • name (str) - new channel name for logging
    • +
+
+
+
+ +
+ +
+ + +
+

set_missing_host_key_policy(self, + policy) +

+ 		source code  +
+ +

Set the policy to use when connecting to a server that doesn't have a + host key in either the system or local HostKeys objects. + The default policy is to reject all unknown servers (using RejectPolicy). + You may substitute AutoAddPolicy or write your own policy class.

+
+
Parameters:
+
    +
  • policy (MissingHostKeyPolicy) - the policy to use when receiving a host key from a + previously-unknown server
    • +
+
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Sun Jul 6 18:30:29 2008 + + http://epydoc.sourceforge.net +
+ + + + -- cgit v1.2.3