← Back to branch summary

~jelmer/ubuntu/natty/paramiko/271791-randompool-deprecation

« back to all changes in this revision

Viewing changes to docs/paramiko.SSHClient-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Adeodato Simó
  • Date: 2008-01-24 13:54:18 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080124135418-npxfwu271vsfsa3c
Tags: 1.7.2-0.1
http://bugs.debian.org/415060
* Non-maintainer upload to DELAYED/14-day. (¹)
* New upstream release. (Closes: #415060)
* Drop the patch introduced in 1.6.4-1.1, as it's part of 1.7.2.

  (¹) Counting since the initial 1.7.1-0.1 upload in Jan 13th.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/paramiko.SSHClient-class.html
86
86
          <span class=summary-sig-arg>username</span>,
87
87
          <span class=summary-sig-arg>password</span>,
88
88
          <span class=summary-sig-arg>pkey</span>,
89
 
          <span class=summary-sig-arg>key_filename</span>)</span></code>
 
89
          <span class=summary-sig-arg>key_filename</span>,
 
90
          <span class=summary-sig-arg>timeout</span>)</span></code>
90
91
<br />
91
92
Connect to an SSH server and authenticate to it.</td></tr>
92
93
<tr><td align="right" valign="top" width="15%"><font size="-1">        tuple(<code>ChannelFile</code>, <code>ChannelFile</code>, 
93
94
        <code>ChannelFile</code>)
94
95
</font></td>
95
96
  <td><code><span class="summary-sig"><a href="paramiko.SSHClient-class.html#exec_command" class="summary-sig-name"><code>exec_command</code></a>(<span class=summary-sig-arg>self</span>,
96
 
          <span class=summary-sig-arg>command</span>)</span></code>
 
97
          <span class=summary-sig-arg>command</span>,
 
98
          <span class=summary-sig-arg>bufsize</span>)</span></code>
97
99
<br />
98
100
Execute a command on the SSH server.</td></tr>
99
101
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="paramiko.HostKeys-class.html" 
103
105
<br />
104
106
Get the local <a href="paramiko.HostKeys-class.html" 
105
107
class="link"><code>HostKeys</code></a> object.</td></tr>
 
108
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="paramiko.Transport-class.html" 
 
109
        class="link"><code>Transport</code></a>
 
110
</font></td>
 
111
  <td><code><span class="summary-sig"><a href="paramiko.SSHClient-class.html#get_transport" class="summary-sig-name"><code>get_transport</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
112
<br />
 
113
Return the underlying <a href="paramiko.Transport-class.html" 
 
114
class="link"><code>Transport</code></a> object for this SSH 
 
115
connection.</td></tr>
106
116
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="paramiko.Channel-class.html" 
107
117
        class="link"><code>Channel</code></a>
108
118
</font></td>
227
237
          <span class=sig-arg>username</span>=<span class=sig-default>None</span>,
228
238
          <span class=sig-arg>password</span>=<span class=sig-default>None</span>,
229
239
          <span class=sig-arg>pkey</span>=<span class=sig-default>None</span>,
230
 
          <span class=sig-arg>key_filename</span>=<span class=sig-default>None</span>)</span>
 
240
          <span class=sig-arg>key_filename</span>=<span class=sig-default>None</span>,
 
241
          <span class=sig-arg>timeout</span>=<span class=sig-default>None</span>)</span>
231
242
  </h3>
232
243
  <p>Connect to an SSH server and authenticate to it. The server's host 
233
244
  key is checked against the system host keys (see <a 
284
295
      <dd><code><b>pkey</b></code> -
285
296
         an optional private key to use for authentication
286
297
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
287
 
        (type=<code>PKey</code>)</i>
 
298
        (type=<a href="paramiko.PKey-class.html" 
 
299
              class="link"><code>PKey</code></a>)</i>
288
300
      <dd><code><b>key_filename</b></code> -
289
301
         the filename of an optional private key to use for 
290
302
        authentication
291
303
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
292
304
        (type=str)</i>
 
305
      <dd><code><b>timeout</b></code> -
 
306
         an optional timeout (in seconds) for the TCP connect
 
307
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
308
        (type=float)</i>
293
309
      </dd>
294
310
    </dl>
295
311
    <dl><dt><b>Raises:</b></dt>
307
323
<a name="exec_command"></a>
308
324
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
309
325
  <h3><span class="sig"><span class="sig-name">exec_command</span>(<span class=sig-arg>self</span>,
310
 
          <span class=sig-arg>command</span>)</span>
 
326
          <span class=sig-arg>command</span>,
 
327
          <span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span>
311
328
  </h3>
312
329
  Execute a command on the SSH server. A new <a 
313
330
  href="paramiko.Channel-class.html" 
321
338
         the command to execute
322
339
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
323
340
        (type=str)</i>
 
341
      <dd><code><b>bufsize</b></code> -
 
342
         interpreted the same way as by the built-in 
 
343
        <code>file()</code> function in python
 
344
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
345
        (type=int)</i>
324
346
      </dd>
325
347
    </dl>
326
348
    <dl><dt><b>Returns:</b></dt>
357
379
  </dd></dl>
358
380
</td></tr></table>
359
381
 
 
382
<a name="get_transport"></a>
 
383
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
384
  <h3><span class="sig"><span class="sig-name">get_transport</span>(<span class=sig-arg>self</span>)</span>
 
385
  </h3>
 
386
  Return the underlying <a href="paramiko.Transport-class.html" 
 
387
  class="link"><code>Transport</code></a> object for this SSH connection. 
 
388
  This can be used to perform lower-level tasks, like opening specific 
 
389
  kinds of channels.
 
390
  <dl><dt></dt><dd>
 
391
    <dl><dt><b>Returns:</b></dt>
 
392
      <dd>
 
393
        the Transport for this connection
 
394
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
395
        (type=<a href="paramiko.Transport-class.html" 
 
396
        class="link"><code>Transport</code></a>)</i>
 
397
      </dd>
 
398
    </dl>
 
399
  </dd></dl>
 
400
</td></tr></table>
 
401
 
360
402
<a name="invoke_shell"></a>
361
403
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
362
404
  <h3><span class="sig"><span class="sig-name">invoke_shell</span>(<span class=sig-arg>self</span>,
568
610
 
569
611
<table border="0" cellpadding="0" cellspacing="0" width="100%">
570
612
  <tr>
571
 
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Nov 19 12:57:13 2006</font></td>
 
613
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Jan 21 19:06:09 2008</font></td>
572
614
    <td align="right"><a href="http://epydoc.sourceforge.net"
573
615
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
574
616
  </tr>