Package paramiko :: Module agent :: Class Agent
[frames] | no frames]

Class Agent

source code

object --+    
         |    
  AgentSSH --+
             |
            Agent


Client interface for using private keys from an SSH agent running on the
local machine.  If an SSH agent is running, this class can be used to
connect to it and retreive `.PKey` objects which can be used when
attempting to authenticate to remote SSH servers.

Upon initialization, a session with the local machine's SSH agent is
opened, if one is running. If no agent is running, initialization will
succeed, but `get_keys` will return an empty tuple.

:raises SSHException:
    if an SSH agent is found, but speaks an incompatible protocol

Instance Methods
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
close(self)
Close the SSH agent connection.
source code

Inherited from AgentSSH: get_keys

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

Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)