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
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
|
<?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.Channel</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 Channel
</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.Channel-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Channel</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#Channel">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">Channel</strong>
</pre>
<hr />
<p>A secure tunnel across an SSH <a href="paramiko.Transport-class.html"
class="link">Transport</a>. A Channel is meant to behave like a socket,
and has an API that should be indistinguishable from the python socket
API.</p>
<p>Because SSH2 has a windowing kind of flow control, if you stop reading
data from a Channel and its buffer fills up, the server will be unable to
send you any more data until you read some of it. (This won't affect
other channels on the same transport -- all channels on a single
transport are flow-controlled independently.) Similarly, if the server
isn't reading data you send, calls to <a
href="paramiko.Channel-class.html#send" class="link">send</a> may block,
unless you set a timeout. This is exactly like a normal network socket,
so it shouldn't be too surprising.</p>
<!-- ==================== 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 name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">chanid</span>)</span><br />
Create a new channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return a string representation of this object, for debugging.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br />
Close the channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-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><br />
Execute a command on the server.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">bool</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#exit_status_ready" class="summary-sig-name">exit_status_ready</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return true if the remote process has exited and returned an exit
status.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#fileno" class="summary-sig-name">fileno</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns an OS-level file descriptor which can be used for polling,
but but <i>not</i> for reading or writing.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#get_id" class="summary-sig-name">get_id</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the ID # for this channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#get_name" class="summary-sig-name">get_name</a>(<span class="summary-sig-arg">self</span>)</span><br />
Get the name of this channel that was previously set by <a
href="paramiko.Channel-class.html#set_name"
class="link">set_name</a>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#get_pty" class="summary-sig-name">get_pty</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 />
Request a pseudo-terminal from the server.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#get_transport" class="summary-sig-name">get_transport</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the <a href="paramiko.Transport-class.html"
class="link">Transport</a> associated with this channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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(str, int)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#getpeername" class="summary-sig-name">getpeername</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the address of the remote side of this Channel, if possible.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">float</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#gettimeout" class="summary-sig-name">gettimeout</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns the timeout in seconds (as a float) associated with socket
operations, or <code>None</code> if no timeout is set.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#invoke_shell" class="summary-sig-name">invoke_shell</a>(<span class="summary-sig-arg">self</span>)</span><br />
Request an interactive shell session on this channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#invoke_subsystem" class="summary-sig-name">invoke_subsystem</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">subsystem</span>)</span><br />
Request a subsystem on the server (for example, <code>sftp</code>).</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">ChannelFile</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#makefile" class="summary-sig-name">makefile</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*params</span>)</span><br />
Return a file-like object associated with this channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">ChannelFile</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#makefile_stderr" class="summary-sig-name">makefile_stderr</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*params</span>)</span><br />
Return a file-like object associated with this channel's stderr
stream.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#recv" class="summary-sig-name">recv</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">nbytes</span>)</span><br />
Receive data from the channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_exit_status" class="summary-sig-name">recv_exit_status</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the exit status from the process on the server.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">boolean</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_ready" class="summary-sig-name">recv_ready</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns true if data is buffered and ready to be read from this
channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_stderr" class="summary-sig-name">recv_stderr</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">nbytes</span>)</span><br />
Receive data from the channel's stderr stream.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">boolean</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_stderr_ready" class="summary-sig-name">recv_stderr_ready</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns true if data is buffered and ready to be read from this
channel's stderr stream.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#request_x11" class="summary-sig-name">request_x11</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">screen_number</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">auth_protocol</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">auth_cookie</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">single_connection</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">handler</span>=<span class="summary-sig-default">None</span>)</span><br />
Request an x11 session on this channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#resize_pty" class="summary-sig-name">resize_pty</a>(<span class="summary-sig-arg">self</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 />
Resize the pseudo-terminal.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#send" class="summary-sig-name">send</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">s</span>)</span><br />
Send data to the channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#send_exit_status" class="summary-sig-name">send_exit_status</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">status</span>)</span><br />
Send the exit status of an executed command to the client.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">boolean</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#send_ready" class="summary-sig-name">send_ready</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns true if data can be written to this channel without blocking.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#send_stderr" class="summary-sig-name">send_stderr</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">s</span>)</span><br />
Send data to the channel on the "stderr" stream.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#sendall" class="summary-sig-name">sendall</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">s</span>)</span><br />
Send data to the channel, without allowing partial results.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#sendall_stderr" class="summary-sig-name">sendall_stderr</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">s</span>)</span><br />
Send data to the channel's "stderr" stream, without
allowing partial results.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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">bool</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.Channel-class.html#set_combine_stderr" class="summary-sig-name">set_combine_stderr</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">combine</span>)</span><br />
Set whether stderr should be combined into stdout on this channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#set_name" class="summary-sig-name">set_name</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Set a name for this channel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#setblocking" class="summary-sig-name">setblocking</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">blocking</span>)</span><br />
Set blocking or non-blocking mode of the channel: if
<code>blocking</code> is 0, the channel is set to non-blocking mode;
otherwise it's set to blocking mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#settimeout" class="summary-sig-name">settimeout</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">timeout</span>)</span><br />
Set a timeout on blocking read/write operations.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#shutdown" class="summary-sig-name">shutdown</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">how</span>)</span><br />
Shut down one or both halves of the connection.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#shutdown_read" class="summary-sig-name">shutdown_read</a>(<span class="summary-sig-arg">self</span>)</span><br />
Shutdown the receiving side of this socket, closing the stream in the
incoming direction.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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.Channel-class.html#shutdown_write" class="summary-sig-name">shutdown_write</a>(<span class="summary-sig-arg">self</span>)</span><br />
Shutdown the sending side of this socket, closing the stream in the
outgoing direction.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.channel-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>__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 class="sig-arg">chanid</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Create a new channel. The channel is not associated with any
particular session or <a href="paramiko.Transport-class.html"
class="link">Transport</a> until the Transport attaches it. Normally you
would only call this method from the constructor of a subclass of <a
href="paramiko.Channel-class.html" class="link">Channel</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>chanid</code></strong> (int) - the ID of this channel, as passed by an existing <a
href="paramiko.Transport-class.html" class="link">Transport</a>.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__repr__"></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">__repr__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return a string representation of this object, for debugging.</p>
<dl class="fields">
<dt>Returns: str</dt>
<dt>Overrides:
object.__repr__
</dt>
</dl>
</td></tr></table>
</div>
<a name="close"></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">close</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Close the channel. All future read/write operations on the channel
will fail. The remote end will receive no more data (after queued data
is flushed). Channels are automatically closed when their <a
href="paramiko.Transport-class.html" class="link">Transport</a> is closed
or when they are garbage collected.</p>
<dl class="fields">
</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>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Execute a command on the server. If the server allows it, the channel
will then be directly connected to the stdin, stdout, and stderr of the
command being executed.</p>
<p>When the command finishes executing, the channel will be closed and
can't be reused. You must open a new channel if you wish to execute
another command.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>command</code></strong> (str) - a shell command to execute.</li>
</ul></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 request was rejected or the channel was closed</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="exit_status_ready"></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">exit_status_ready</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return true if the remote process has exited and returned an exit
status. You may use this to poll the process status if you don't want to
block in <a href="paramiko.Channel-class.html#recv_exit_status"
class="link">recv_exit_status</a>. Note that the server may not return an
exit status in some cases (like bad servers).</p>
<dl class="fields">
<dt>Returns: bool</dt>
<dd>True if <a href="paramiko.Channel-class.html#recv_exit_status"
class="link">recv_exit_status</a> will return immediately</dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.7.3
</p>
</div></td></tr></table>
</div>
<a name="fileno"></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">fileno</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Returns an OS-level file descriptor which can be used for polling, but
but <i>not</i> for reading or writing. This is primaily to allow
python's <code>select</code> module to work.</p>
<p>The first time <code>fileno</code> is called on a channel, a pipe is
created to simulate real OS-level file descriptor (FD) behavior. Because
of this, two OS-level FDs are created, which will use up FDs faster than
normal. (You won't notice this effect unless you have hundreds of
channels open at the same time.)</p>
<dl class="fields">
<dt>Returns: int</dt>
<dd>an OS-level file descriptor</dd>
</dl>
<div class="fields"> <p><strong>Warning:</strong>
This method causes channel reads to be slightly less efficient.
</p>
</div></td></tr></table>
</div>
<a name="get_id"></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_id</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return the ID # for this channel. The channel ID is unique across a
<a href="paramiko.Transport-class.html" class="link">Transport</a> and
usually a small number. It's also the number passed to <a
href="paramiko.ServerInterface-class.html#check_channel_request"
class="link">ServerInterface.check_channel_request</a> when determining
whether to accept a channel request in server mode.</p>
<dl class="fields">
<dt>Returns: int</dt>
<dd>the ID of this channel.</dd>
</dl>
</td></tr></table>
</div>
<a name="get_name"></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_name</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Get the name of this channel that was previously set by <a
href="paramiko.Channel-class.html#set_name"
class="link">set_name</a>.</p>
<dl class="fields">
<dt>Returns: str</dt>
<dd>the name of this channel.</dd>
</dl>
</td></tr></table>
</div>
<a name="get_pty"></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_pty</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.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Request a pseudo-terminal from the server. This is usually used right
after creating a client channel, to ask the server to provide some basic
terminal semantics for a shell invoked with <a
href="paramiko.Channel-class.html#invoke_shell"
class="link">invoke_shell</a>. It isn't necessary (or desirable) to call
this method if you're going to exectue a single command with <a
href="paramiko.Channel-class.html#exec_command"
class="link">exec_command</a>.</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) - width (in characters) of the terminal screen</li>
<li><strong class="pname"><code>height</code></strong> (int) - height (in characters) of the terminal screen</li>
</ul></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 request was rejected or the channel was closed</li>
</ul></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.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return the <a href="paramiko.Transport-class.html"
class="link">Transport</a> associated with this channel.</p>
<dl class="fields">
<dt>Returns: <a href="paramiko.Transport-class.html" class="link">Transport</a></dt>
<dd>the <a href="paramiko.Transport-class.html"
class="link">Transport</a> that was used to create this channel.</dd>
</dl>
</td></tr></table>
</div>
<a name="getpeername"></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">getpeername</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return the address of the remote side of this Channel, if possible.
This is just a wrapper around <code>'getpeername'</code> on the
Transport, used to provide enough of a socket-like interface to allow
asyncore to work. (asyncore likes to call
<code>'getpeername'</code>.)</p>
<dl class="fields">
<dt>Returns: tuple(str, int)</dt>
<dd>the address if the remote host, if known</dd>
</dl>
</td></tr></table>
</div>
<a name="gettimeout"></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">gettimeout</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Returns the timeout in seconds (as a float) associated with socket
operations, or <code>None</code> if no timeout is set. This reflects the
last call to <a href="paramiko.Channel-class.html#setblocking"
class="link">setblocking</a> or <a
href="paramiko.Channel-class.html#settimeout"
class="link">settimeout</a>.</p>
<dl class="fields">
<dt>Returns: float</dt>
<dd>timeout in seconds, or <code>None</code>.</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>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Request an interactive shell session on this channel. If the server
allows it, the channel will then be directly connected to the stdin,
stdout, and stderr of the shell.</p>
<p>Normally you would call <a href="paramiko.Channel-class.html#get_pty"
class="link">get_pty</a> before this, in which case the shell will
operate through the pty, and the channel will be connected to the stdin
and stdout of the pty.</p>
<p>When the shell exits, the channel will be closed and can't be reused.
You must open a new channel if you wish to open another shell.</p>
<dl class="fields">
<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 request was rejected or the channel was closed</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="invoke_subsystem"></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_subsystem</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">subsystem</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Request a subsystem on the server (for example, <code>sftp</code>).
If the server allows it, the channel will then be directly connected to
the requested subsystem.</p>
<p>When the subsystem finishes, the channel will be closed and can't be
reused.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>subsystem</code></strong> (str) - name of the subsystem being requested.</li>
</ul></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 request was rejected or the channel was closed</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="makefile"></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">makefile</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*params</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return a file-like object associated with this channel. The optional
<code>mode</code> and <code>bufsize</code> arguments are interpreted the
same way as by the built-in <code>file()</code> function in python.</p>
<dl class="fields">
<dt>Returns: ChannelFile</dt>
<dd>object which can be used for python file I/O.</dd>
</dl>
</td></tr></table>
</div>
<a name="makefile_stderr"></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">makefile_stderr</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*params</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return a file-like object associated with this channel's stderr
stream. Only channels using <a
href="paramiko.Channel-class.html#exec_command"
class="link">exec_command</a> or <a
href="paramiko.Channel-class.html#invoke_shell"
class="link">invoke_shell</a> without a pty will ever have data on the
stderr stream.</p>
<p>The optional <code>mode</code> and <code>bufsize</code> arguments are
interpreted the same way as by the built-in <code>file()</code> function
in python. For a client, it only makes sense to open this file for
reading. For a server, it only makes sense to open this file for
writing.</p>
<dl class="fields">
<dt>Returns: ChannelFile</dt>
<dd>object which can be used for python file I/O.</dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.1
</p>
</div></td></tr></table>
</div>
<a name="recv"></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">recv</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">nbytes</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Receive data from the channel. The return value is a string
representing the data received. The maximum amount of data to be
received at once is specified by <code>nbytes</code>. If a string of
length zero is returned, the channel stream has closed.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>nbytes</code></strong> (int) - maximum number of bytes to read.</li>
</ul></dd>
<dt>Returns: str</dt>
<dd>data.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>socket.timeout</strong></code> - if no data is ready before the timeout set by <a
href="paramiko.Channel-class.html#settimeout"
class="link">settimeout</a>.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="recv_exit_status"></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">recv_exit_status</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return the exit status from the process on the server. This is mostly
useful for retrieving the reults of an <a
href="paramiko.Channel-class.html#exec_command"
class="link">exec_command</a>. If the command hasn't finished yet, this
method will wait until it does, or until the channel is closed. If no
exit status is provided by the server, -1 is returned.</p>
<dl class="fields">
<dt>Returns: int</dt>
<dd>the exit code of the process on the server.</dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.2
</p>
</div></td></tr></table>
</div>
<a name="recv_ready"></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">recv_ready</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Returns true if data is buffered and ready to be read from this
channel. A <code>False</code> result does not mean that the channel has
closed; it means you may need to wait before more data arrives.</p>
<dl class="fields">
<dt>Returns: boolean</dt>
<dd><code>True</code> if a <a href="paramiko.Channel-class.html#recv"
class="link">recv</a> call on this channel would immediately
return at least one byte; <code>False</code> otherwise.</dd>
</dl>
</td></tr></table>
</div>
<a name="recv_stderr"></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">recv_stderr</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">nbytes</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Receive data from the channel's stderr stream. Only channels using <a
href="paramiko.Channel-class.html#exec_command"
class="link">exec_command</a> or <a
href="paramiko.Channel-class.html#invoke_shell"
class="link">invoke_shell</a> without a pty will ever have data on the
stderr stream. The return value is a string representing the data
received. The maximum amount of data to be received at once is specified
by <code>nbytes</code>. If a string of length zero is returned, the
channel stream has closed.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>nbytes</code></strong> (int) - maximum number of bytes to read.</li>
</ul></dd>
<dt>Returns: str</dt>
<dd>data.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>socket.timeout</strong></code> - if no data is ready before the timeout set by <a
href="paramiko.Channel-class.html#settimeout"
class="link">settimeout</a>.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.1
</p>
</div></td></tr></table>
</div>
<a name="recv_stderr_ready"></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">recv_stderr_ready</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Returns true if data is buffered and ready to be read from this
channel's stderr stream. Only channels using <a
href="paramiko.Channel-class.html#exec_command"
class="link">exec_command</a> or <a
href="paramiko.Channel-class.html#invoke_shell"
class="link">invoke_shell</a> without a pty will ever have data on the
stderr stream.</p>
<dl class="fields">
<dt>Returns: boolean</dt>
<dd><code>True</code> if a <a
href="paramiko.Channel-class.html#recv_stderr"
class="link">recv_stderr</a> call on this channel would
immediately return at least one byte; <code>False</code>
otherwise.</dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.1
</p>
</div></td></tr></table>
</div>
<a name="request_x11"></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">request_x11</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">screen_number</span>=<span class="sig-default">0</span>,
<span class="sig-arg">auth_protocol</span>=<span class="sig-default">None</span>,
<span class="sig-arg">auth_cookie</span>=<span class="sig-default">None</span>,
<span class="sig-arg">single_connection</span>=<span class="sig-default">False</span>,
<span class="sig-arg">handler</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Request an x11 session on this channel. If the server allows it,
further x11 requests can be made from the server to the client, when an
x11 application is run in a shell session.</p>
<p>From RFC4254:</p>
<pre class="literalblock">
It is RECOMMENDED that the 'x11 authentication cookie' that is
sent be a fake, random cookie, and that the cookie be checked and
replaced by the real cookie when a connection request is received.
</pre>
<p>If you omit the auth_cookie, a new secure random 128-bit value will be
generated, used, and returned. You will need to use this value to verify
incoming x11 requests and replace them with the actual local x11 cookie
(which requires some knoweldge of the x11 protocol).</p>
<p>If a handler is passed in, the handler is called from another thread
whenever a new x11 connection arrives. The default handler queues up
incoming x11 connections, which may be retrieved using <a
href="paramiko.Transport-class.html#accept"
class="link">Transport.accept</a>. The handler's calling signature
is:</p>
<pre class="literalblock">
handler(channel: Channel, (address: str, port: int))
</pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>screen_number</code></strong> (int) - the x11 screen number (0, 10, etc)</li>
<li><strong class="pname"><code>auth_protocol</code></strong> (str) - the name of the X11 authentication method used; if none is given,
<code>"MIT-MAGIC-COOKIE-1"</code> is used</li>
<li><strong class="pname"><code>auth_cookie</code></strong> (str) - hexadecimal string containing the x11 auth cookie; if none is
given, a secure random 128-bit value is generated</li>
<li><strong class="pname"><code>single_connection</code></strong> (bool) - if True, only a single x11 connection will be forwarded (by
default, any number of x11 connections can arrive over this
session)</li>
<li><strong class="pname"><code>handler</code></strong> (function) - an optional handler to use for incoming X11 connections</li>
</ul></dd>
<dt>Returns:</dt>
<dd>the auth_cookie used</dd>
</dl>
</td></tr></table>
</div>
<a name="resize_pty"></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">resize_pty</span>(<span class="sig-arg">self</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.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Resize the pseudo-terminal. This can be used to change the width and
height of the terminal emulation created in a previous <a
href="paramiko.Channel-class.html#get_pty" class="link">get_pty</a>
call.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>width</code></strong> (int) - new width (in characters) of the terminal screen</li>
<li><strong class="pname"><code>height</code></strong> (int) - new height (in characters) of the terminal screen</li>
</ul></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 request was rejected or the channel was closed</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="send"></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">send</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">s</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Send data to the channel. Returns the number of bytes sent, or 0 if
the channel stream is closed. Applications are responsible for checking
that all data has been sent: if only some of the data was transmitted,
the application needs to attempt delivery of the remaining data.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>s</code></strong> (str) - data to send</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>number of bytes actually sent</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>socket.timeout</strong></code> - if no data could be sent before the timeout set by <a
href="paramiko.Channel-class.html#settimeout"
class="link">settimeout</a>.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="send_exit_status"></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">send_exit_status</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">status</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Send the exit status of an executed command to the client. (This
really only makes sense in server mode.) Many clients expect to get some
sort of status code back from an executed command after it completes.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>status</code></strong> (int) - the exit code of the process</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.2
</p>
</div></td></tr></table>
</div>
<a name="send_ready"></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">send_ready</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Returns true if data can be written to this channel without blocking.
This means the channel is either closed (so any write attempt would
return immediately) or there is at least one byte of space in the
outbound buffer. If there is at least one byte of space in the outbound
buffer, a <a href="paramiko.Channel-class.html#send"
class="link">send</a> call will succeed immediately and return the number
of bytes actually written.</p>
<dl class="fields">
<dt>Returns: boolean</dt>
<dd><code>True</code> if a <a href="paramiko.Channel-class.html#send"
class="link">send</a> call on this channel would immediately
succeed or fail</dd>
</dl>
</td></tr></table>
</div>
<a name="send_stderr"></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">send_stderr</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">s</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Send data to the channel on the "stderr" stream. This is
normally only used by servers to send output from shell commands --
clients won't use this. Returns the number of bytes sent, or 0 if the
channel stream is closed. Applications are responsible for checking that
all data has been sent: if only some of the data was transmitted, the
application needs to attempt delivery of the remaining data.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>s</code></strong> (str) - data to send.</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>number of bytes actually sent.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>socket.timeout</strong></code> - if no data could be sent before the timeout set by <a
href="paramiko.Channel-class.html#settimeout"
class="link">settimeout</a>.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.1
</p>
</div></td></tr></table>
</div>
<a name="sendall"></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">sendall</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">s</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Send data to the channel, without allowing partial results. Unlike <a
href="paramiko.Channel-class.html#send" class="link">send</a>, this
method continues to send data from the given string until either all data
has been sent or an error occurs. Nothing is returned.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>s</code></strong> (str) - data to send.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>socket.timeout</strong></code> - if sending stalled for longer than the timeout set by <a
href="paramiko.Channel-class.html#settimeout"
class="link">settimeout</a>.</li>
<li><code><strong class='fraise'>socket.error</strong></code> - if an error occured before the entire string was sent.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
If the channel is closed while only part of the data hase been
sent, there is no way to determine how much data (if any) was sent.
This is irritating, but identically follows python's API.
</p>
</div></td></tr></table>
</div>
<a name="sendall_stderr"></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">sendall_stderr</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">s</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Send data to the channel's "stderr" stream, without allowing
partial results. Unlike <a
href="paramiko.Channel-class.html#send_stderr"
class="link">send_stderr</a>, this method continues to send data from the
given string until all data has been sent or an error occurs. Nothing is
returned.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>s</code></strong> (str) - data to send to the client as "stderr" output.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>socket.timeout</strong></code> - if sending stalled for longer than the timeout set by <a
href="paramiko.Channel-class.html#settimeout"
class="link">settimeout</a>.</li>
<li><code><strong class='fraise'>socket.error</strong></code> - if an error occured before the entire string was sent.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.1
</p>
</div></td></tr></table>
</div>
<a name="set_combine_stderr"></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_combine_stderr</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">combine</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Set whether stderr should be combined into stdout on this channel. The
default is <code>False</code>, but in some cases it may be convenient to
have both streams combined.</p>
<p>If this is <code>False</code>, and <a
href="paramiko.Channel-class.html#exec_command"
class="link">exec_command</a> is called (or <code>invoke_shell</code>
with no pty), output to stderr will not show up through the <a
href="paramiko.Channel-class.html#recv" class="link">recv</a> and <a
href="paramiko.Channel-class.html#recv_ready" class="link">recv_ready</a>
calls. You will have to use <a
href="paramiko.Channel-class.html#recv_stderr"
class="link">recv_stderr</a> and <a
href="paramiko.Channel-class.html#recv_stderr_ready"
class="link">recv_stderr_ready</a> to get stderr output.</p>
<p>If this is <code>True</code>, data will never show up via <a
href="paramiko.Channel-class.html#recv_stderr"
class="link">recv_stderr</a> or <a
href="paramiko.Channel-class.html#recv_stderr_ready"
class="link">recv_stderr_ready</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>combine</code></strong> (bool) - <code>True</code> if stderr output should be combined into stdout
on this channel.</li>
</ul></dd>
<dt>Returns: bool</dt>
<dd>previous setting.</dd>
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.1
</p>
</div></td></tr></table>
</div>
<a name="set_name"></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_name</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.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Set a name for this channel. Currently it's only used to set the name
of the channel in logfile entries. The name can be fetched with the <a
href="paramiko.Channel-class.html#get_name" class="link">get_name</a>
method.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (str) - new channel name</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setblocking"></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">setblocking</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">blocking</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Set blocking or non-blocking mode of the channel: if
<code>blocking</code> is 0, the channel is set to non-blocking mode;
otherwise it's set to blocking mode. Initially all channels are in
blocking mode.</p>
<p>In non-blocking mode, if a <a href="paramiko.Channel-class.html#recv"
class="link">recv</a> call doesn't find any data, or if a <a
href="paramiko.Channel-class.html#send" class="link">send</a> call can't
immediately dispose of the data, an error exception is raised. In
blocking mode, the calls block until they can proceed. An EOF condition
is considered "immediate data" for <a
href="paramiko.Channel-class.html#recv" class="link">recv</a>, so if the
channel is closed in the read direction, it will never block.</p>
<p><code>chan.setblocking(0)</code> is equivalent to
<code>chan.settimeout(0)</code>; <code>chan.setblocking(1)</code> is
equivalent to <code>chan.settimeout(None)</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>blocking</code></strong> (int) - 0 to set non-blocking mode; non-0 to set blocking mode.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="settimeout"></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">settimeout</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">timeout</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Set a timeout on blocking read/write operations. The
<code>timeout</code> argument can be a nonnegative float expressing
seconds, or <code>None</code>. If a float is given, subsequent channel
read/write operations will raise a timeout exception if the timeout
period value has elapsed before the operation has completed. Setting a
timeout of <code>None</code> disables timeouts on socket operations.</p>
<p><code>chan.settimeout(0.0)</code> is equivalent to
<code>chan.setblocking(0)</code>; <code>chan.settimeout(None)</code> is
equivalent to <code>chan.setblocking(1)</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>timeout</code></strong> (float) - seconds to wait for a pending read/write operation before raising
<code>socket.timeout</code>, or <code>None</code> for no timeout.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="shutdown"></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">shutdown</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">how</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Shut down one or both halves of the connection. If <code>how</code>
is 0, further receives are disallowed. If <code>how</code> is 1, further
sends are disallowed. If <code>how</code> is 2, further sends and
receives are disallowed. This closes the stream in one or both
directions.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>how</code></strong> (int) - 0 (stop receiving), 1 (stop sending), or 2 (stop receiving and
sending).</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="shutdown_read"></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">shutdown_read</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Shutdown the receiving side of this socket, closing the stream in the
incoming direction. After this call, future reads on this channel will
fail instantly. This is a convenience method, equivalent to
<code>shutdown(0)</code>, for people who don't make it a habit to
memorize unix constants from the 1970s.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.2
</p>
</div></td></tr></table>
</div>
<a name="shutdown_write"></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">shutdown_write</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.channel-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Shutdown the sending side of this socket, closing the stream in the
outgoing direction. After this call, future writes on this channel will
fail instantly. This is a convenience method, equivalent to
<code>shutdown(1)</code>, for people who don't make it a habit to
memorize unix constants from the 1970s.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>Since:</strong>
1.2
</p>
</div></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 Sun Nov 1 22:14:16 2009
</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>
|
