1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>paramiko.SSHClient</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="paramiko-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="paramiko-module.html">Package paramiko</a> ::
Class SSHClient
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="paramiko.SSHClient-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class SSHClient</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#SSHClient">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">SSHClient</strong>
</pre>
<hr />
<p>A high-level representation of a session with an SSH server. This
class wraps <a href="paramiko.Transport-class.html"
class="link">Transport</a>, <a href="paramiko.Channel-class.html"
class="link">Channel</a>, and <a href="paramiko.SFTPClient-class.html"
class="link">SFTPClient</a> to take care of most aspects of
authenticating and opening channels. A typical use case is:</p>
<pre class="literalblock">
client = SSHClient()
client.load_system_host_keys()
client.connect('ssh.example.com')
stdin, stdout, stderr = client.exec_command('ls -l')
</pre>
<p>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).</p>
<hr />
<div class="fields"> <p><strong>Since:</strong>
1.6
</p>
</div><!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Create a new SSHClient.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span><br />
Close this SSHClient and its underlying <a
href="paramiko.Transport-class.html" class="link">Transport</a>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">hostname</span>,
<span class="summary-sig-arg">port</span>=<span class="summary-sig-default">22</span>,
<span class="summary-sig-arg">username</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">password</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">pkey</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">key_filename</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">allow_agent</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">look_for_keys</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">compress</span>=<span class="summary-sig-default">False</span>)</span><br />
Connect to an SSH server and authenticate to it.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">tuple(ChannelFile, ChannelFile, ChannelFile)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#exec_command" class="summary-sig-name">exec_command</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">command</span>,
<span class="summary-sig-arg">bufsize</span>=<span class="summary-sig-default">-1</span>)</span><br />
Execute a command on the SSH server.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="paramiko.HostKeys-class.html" class="link">HostKeys</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#get_host_keys" class="summary-sig-name">get_host_keys</a>(<span class="summary-sig-arg">self</span>)</span><br />
Get the local <a href="paramiko.HostKeys-class.html"
class="link">HostKeys</a> object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="paramiko.Transport-class.html" class="link">Transport</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#get_transport" class="summary-sig-name">get_transport</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the underlying <a href="paramiko.Transport-class.html"
class="link">Transport</a> object for this SSH connection.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="paramiko.Channel-class.html" class="link">Channel</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#invoke_shell" class="summary-sig-name">invoke_shell</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">term</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">vt100</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">width</span>=<span class="summary-sig-default">80</span>,
<span class="summary-sig-arg">height</span>=<span class="summary-sig-default">24</span>)</span><br />
Start an interactive shell session on the SSH server.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#load_host_keys" class="summary-sig-name">load_host_keys</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">filename</span>)</span><br />
Load host keys from a local host-key file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#load_system_host_keys" class="summary-sig-name">load_system_host_keys</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>)</span><br />
Load host keys from a system (read-only) file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="paramiko.SFTPClient-class.html" class="link">SFTPClient</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#open_sftp" class="summary-sig-name">open_sftp</a>(<span class="summary-sig-arg">self</span>)</span><br />
Open an SFTP session on the SSH server.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#save_host_keys" class="summary-sig-name">save_host_keys</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">filename</span>)</span><br />
Save the host keys back to a file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#set_log_channel" class="summary-sig-name">set_log_channel</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Set the channel for logging.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SSHClient-class.html#set_missing_host_key_policy" class="summary-sig-name">set_missing_host_key_policy</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">policy</span>)</span><br />
Set the policy to use when connecting to a server that doesn't have a
host key in either the system or local <a
href="paramiko.HostKeys-class.html" class="link">HostKeys</a>
objects.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Create a new SSHClient.</p>
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="connect"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">hostname</span>,
<span class="sig-arg">port</span>=<span class="sig-default">22</span>,
<span class="sig-arg">username</span>=<span class="sig-default">None</span>,
<span class="sig-arg">password</span>=<span class="sig-default">None</span>,
<span class="sig-arg">pkey</span>=<span class="sig-default">None</span>,
<span class="sig-arg">key_filename</span>=<span class="sig-default">None</span>,
<span class="sig-arg">timeout</span>=<span class="sig-default">None</span>,
<span class="sig-arg">allow_agent</span>=<span class="sig-default">True</span>,
<span class="sig-arg">look_for_keys</span>=<span class="sig-default">True</span>,
<span class="sig-arg">compress</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Connect to an SSH server and authenticate to it. The server's host
key is checked against the system host keys (see <a
href="paramiko.SSHClient-class.html#load_system_host_keys"
class="link">load_system_host_keys</a>) and any local host keys (<a
href="paramiko.SSHClient-class.html#load_host_keys"
class="link">load_host_keys</a>). If the server's hostname is not found
in either set of host keys, the missing host key policy is used (see <a
href="paramiko.SSHClient-class.html#set_missing_host_key_policy"
class="link">set_missing_host_key_policy</a>). The default policy is to
reject the key and raise an <a href="paramiko.SSHException-class.html"
class="link">SSHException</a>.</p>
<p>Authentication is attempted in the following order of priority:</p>
<ul>
<li>
The <code>pkey</code> or <code>key_filename</code> passed in (if any)
</li>
<li>
Any key we can find through an SSH agent
</li>
<li>
Any "id_rsa" or "id_dsa" key discoverable in
<code>~/.ssh/</code>
</li>
<li>
Plain username/password auth, if a password was given
</li>
</ul>
<p>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.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>hostname</code></strong> (str) - the server to connect to</li>
<li><strong class="pname"><code>port</code></strong> (int) - the server port to connect to</li>
<li><strong class="pname"><code>username</code></strong> (str) - the username to authenticate as (defaults to the current local
username)</li>
<li><strong class="pname"><code>password</code></strong> (str) - a password to use for authentication or for unlocking a private
key</li>
<li><strong class="pname"><code>pkey</code></strong> (<a href="paramiko.PKey-class.html" class="link">PKey</a>) - an optional private key to use for authentication</li>
<li><strong class="pname"><code>key_filename</code></strong> (str or list(str)) - the filename, or list of filenames, of optional private key(s) to
try for authentication</li>
<li><strong class="pname"><code>timeout</code></strong> (float) - an optional timeout (in seconds) for the TCP connect</li>
<li><strong class="pname"><code>allow_agent</code></strong> (bool) - set to False to disable connecting to the SSH agent</li>
<li><strong class="pname"><code>look_for_keys</code></strong> (bool) - set to False to disable searching for discoverable private key
files in <code>~/.ssh/</code></li>
<li><strong class="pname"><code>compress</code></strong> (bool) - set to True to turn on compression</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="paramiko.BadHostKeyException-class.html">BadHostKeyException</a></strong></code> - if the server's host key could not be verified</li>
<li><code><strong class='fraise'><a href="paramiko.AuthenticationException-class.html">AuthenticationException</a></strong></code> - if authentication failed</li>
<li><code><strong class='fraise'><a href="paramiko.SSHException-class.html">SSHException</a></strong></code> - if there was any other error connecting or establishing an SSH
session</li>
<li><code><strong class='fraise'>socket.error</strong></code> - if a socket error occurred while connecting</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="exec_command"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">exec_command</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">command</span>,
<span class="sig-arg">bufsize</span>=<span class="sig-default">-1</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Execute a command on the SSH server. A new <a
href="paramiko.Channel-class.html" class="link">Channel</a> is opened and
the requested command is executed. The command's input and output
streams are returned as python <code>file</code>-like objects
representing stdin, stdout, and stderr.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>command</code></strong> (str) - the command to execute</li>
<li><strong class="pname"><code>bufsize</code></strong> (int) - interpreted the same way as by the built-in <code>file()</code>
function in python</li>
</ul></dd>
<dt>Returns: tuple(ChannelFile, ChannelFile, ChannelFile)</dt>
<dd>the stdin, stdout, and stderr of the executing command</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="paramiko.SSHException-class.html">SSHException</a></strong></code> - if the server fails to execute the command</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="get_host_keys"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_host_keys</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Get the local <a href="paramiko.HostKeys-class.html"
class="link">HostKeys</a> object. This can be used to examine the local
host keys or change them.</p>
<dl class="fields">
<dt>Returns: <a href="paramiko.HostKeys-class.html" class="link">HostKeys</a></dt>
<dd>the local host keys</dd>
</dl>
</td></tr></table>
</div>
<a name="get_transport"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_transport</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return the underlying <a href="paramiko.Transport-class.html"
class="link">Transport</a> object for this SSH connection. This can be
used to perform lower-level tasks, like opening specific kinds of
channels.</p>
<dl class="fields">
<dt>Returns: <a href="paramiko.Transport-class.html" class="link">Transport</a></dt>
<dd>the Transport for this connection</dd>
</dl>
</td></tr></table>
</div>
<a name="invoke_shell"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">invoke_shell</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">term</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">vt100</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">width</span>=<span class="sig-default">80</span>,
<span class="sig-arg">height</span>=<span class="sig-default">24</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Start an interactive shell session on the SSH server. A new <a
href="paramiko.Channel-class.html" class="link">Channel</a> is opened and
connected to a pseudo-terminal using the requested terminal type and
size.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>term</code></strong> (str) - the terminal type to emulate (for example,
<code>"vt100"</code>)</li>
<li><strong class="pname"><code>width</code></strong> (int) - the width (in characters) of the terminal window</li>
<li><strong class="pname"><code>height</code></strong> (int) - the height (in characters) of the terminal window</li>
</ul></dd>
<dt>Returns: <a href="paramiko.Channel-class.html" class="link">Channel</a></dt>
<dd>a new channel connected to the remote shell</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="paramiko.SSHException-class.html">SSHException</a></strong></code> - if the server fails to invoke a shell</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="load_host_keys"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">load_host_keys</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">filename</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Load host keys from a local host-key file. Host keys read with this
method will be checked <i>after</i> keys loaded via <a
href="paramiko.SSHClient-class.html#load_system_host_keys"
class="link">load_system_host_keys</a>, but will be saved back by <a
href="paramiko.SSHClient-class.html#save_host_keys"
class="link">save_host_keys</a> (so they can be modified). The missing
host key policy <a href="paramiko.AutoAddPolicy-class.html"
class="link">AutoAddPolicy</a> adds keys to this set and saves them, when
connecting to a previously-unknown server.</p>
<p>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.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filename</code></strong> (str) - the filename to read</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - if the filename could not be read</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="load_system_host_keys"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">load_system_host_keys</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">filename</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Load host keys from a system (read-only) file. Host keys read with
this method will not be saved back by <a
href="paramiko.SSHClient-class.html#save_host_keys"
class="link">save_host_keys</a>.</p>
<p>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).</p>
<p>If <code>filename</code> is left as <code>None</code>, 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.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filename</code></strong> (str) - the filename to read, or <code>None</code></li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - if a filename was provided and the file could not be read</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="open_sftp"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">open_sftp</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Open an SFTP session on the SSH server.</p>
<dl class="fields">
<dt>Returns: <a href="paramiko.SFTPClient-class.html" class="link">SFTPClient</a></dt>
<dd>a new SFTP session object</dd>
</dl>
</td></tr></table>
</div>
<a name="save_host_keys"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">save_host_keys</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">filename</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Save the host keys back to a file. Only the host keys loaded with <a
href="paramiko.SSHClient-class.html#load_host_keys"
class="link">load_host_keys</a> (plus any added directly) will be saved
-- not any host keys loaded with <a
href="paramiko.SSHClient-class.html#load_system_host_keys"
class="link">load_system_host_keys</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filename</code></strong> (str) - the filename to save to</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - if the file could not be written</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="set_log_channel"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">set_log_channel</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Set the channel for logging. The default is
<code>"paramiko.transport"</code> but it can be set to anything
you want.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (str) - new channel name for logging</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="set_missing_host_key_policy"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">set_missing_host_key_policy</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">policy</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.client-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Set the policy to use when connecting to a server that doesn't have a
host key in either the system or local <a
href="paramiko.HostKeys-class.html" class="link">HostKeys</a> objects.
The default policy is to reject all unknown servers (using <a
href="paramiko.RejectPolicy-class.html" class="link">RejectPolicy</a>).
You may substitute <a href="paramiko.AutoAddPolicy-class.html"
class="link">AutoAddPolicy</a> or write your own policy class.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>policy</code></strong> (<a href="paramiko.MissingHostKeyPolicy-class.html"
class="link">MissingHostKeyPolicy</a>) - the policy to use when receiving a host key from a
previously-unknown server</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="paramiko-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon May 23 13:50:03 2011
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|