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
|
<?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>CedarBackup2.peer.RemotePeer</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="CedarBackup2-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>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="CedarBackup2-module.html">Package CedarBackup2</a> ::
<a href="CedarBackup2.peer-module.html">Module peer</a> ::
Class RemotePeer
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="CedarBackup2.peer.RemotePeer-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class RemotePeer</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">RemotePeer</strong>
</pre>
<hr />
<p>Backup peer representing a remote peer in a backup pool.</p>
<p>This is a class representing a remote (networked) peer in a backup
pool. Remote peers are backed up using an rcp-compatible copy command. A
remote peer has associated with it a name (which must be a valid
hostname), a collect directory, a working directory and a copy method (an
rcp-compatible command).</p>
<p>You can also set an optional local user value. This username will be
used as the local user for any remote copies that are required. It can
only be used if the root user is executing the backup. The root user
will <code>su</code> to the local user and execute the remote copies as
that user.</p>
<p>The copy method is associated with the peer and not with the actual
request to copy, because we can envision that each remote host might have
a different connect method.</p>
<p>The public methods other than the constructor are part of a
"backup peer" interface shared with the <code>LocalPeer</code>
class.</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 colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</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="CedarBackup2.peer.RemotePeer-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">collectDir</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">workingDir</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">remoteUser</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">rcpCommand</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">localUser</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">rshCommand</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">cbackCommand</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ignoreFailureMode</span>=<span class="summary-sig-default">None</span>)</span><br />
Initializes a remote backup peer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.__init__">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="CedarBackup2.peer.RemotePeer-class.html#stagePeer" class="summary-sig-name">stagePeer</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">targetDir</span>,
<span class="summary-sig-arg">ownership</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">permissions</span>=<span class="summary-sig-default">None</span>)</span><br />
Stages data from the peer into the indicated local target directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.stagePeer">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="CedarBackup2.peer.RemotePeer-class.html#checkCollectIndicator" class="summary-sig-name">checkCollectIndicator</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">collectIndicator</span>=<span class="summary-sig-default">None</span>)</span><br />
Checks the collect indicator in the peer's staging directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.checkCollectIndicator">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="CedarBackup2.peer.RemotePeer-class.html#writeStageIndicator" class="summary-sig-name">writeStageIndicator</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">stageIndicator</span>=<span class="summary-sig-default">None</span>)</span><br />
Writes the stage indicator in the peer's staging directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.writeStageIndicator">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="CedarBackup2.peer.RemotePeer-class.html#executeRemoteCommand" class="summary-sig-name">executeRemoteCommand</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">command</span>)</span><br />
Executes a command on the peer via remote shell.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.executeRemoteCommand">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="CedarBackup2.peer.RemotePeer-class.html#executeManagedAction" class="summary-sig-name">executeManagedAction</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">action</span>,
<span class="summary-sig-arg">fullBackup</span>)</span><br />
Executes a managed action on this peer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.executeManagedAction">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setName" class="summary-sig-name" onclick="show_private();">_setName</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the peer name.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setName">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getName"></a><span class="summary-sig-name">_getName</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the peer name.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getName">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setCollectDir" class="summary-sig-name" onclick="show_private();">_setCollectDir</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the collect directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setCollectDir">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getCollectDir"></a><span class="summary-sig-name">_getCollectDir</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the collect directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getCollectDir">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setWorkingDir" class="summary-sig-name" onclick="show_private();">_setWorkingDir</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the working directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setWorkingDir">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getWorkingDir"></a><span class="summary-sig-name">_getWorkingDir</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the working directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getWorkingDir">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setRemoteUser" class="summary-sig-name" onclick="show_private();">_setRemoteUser</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the remote user.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setRemoteUser">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getRemoteUser"></a><span class="summary-sig-name">_getRemoteUser</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the remote user.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getRemoteUser">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setLocalUser" class="summary-sig-name" onclick="show_private();">_setLocalUser</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the local user.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setLocalUser">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getLocalUser"></a><span class="summary-sig-name">_getLocalUser</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the local user.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getLocalUser">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setRcpCommand" class="summary-sig-name" onclick="show_private();">_setRcpCommand</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target to set the rcp command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setRcpCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getRcpCommand"></a><span class="summary-sig-name">_getRcpCommand</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the rcp command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getRcpCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setRshCommand" class="summary-sig-name" onclick="show_private();">_setRshCommand</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target to set the rsh command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setRshCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getRshCommand"></a><span class="summary-sig-name">_getRshCommand</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the rsh command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getRshCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setCbackCommand" class="summary-sig-name" onclick="show_private();">_setCbackCommand</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target to set the cback command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setCbackCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getCbackCommand"></a><span class="summary-sig-name">_getCbackCommand</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the cback command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getCbackCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_setIgnoreFailureMode" class="summary-sig-name" onclick="show_private();">_setIgnoreFailureMode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the ignoreFailure mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setIgnoreFailureMode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_getIgnoreFailureMode"></a><span class="summary-sig-name">_getIgnoreFailureMode</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the ignoreFailure mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getIgnoreFailureMode">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>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__str__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Static Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-StaticMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_getDirContents" class="summary-sig-name" onclick="show_private();">_getDirContents</a>(<span class="summary-sig-arg">path</span>)</span><br />
Returns the contents of a directory in terms of a Set.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getDirContents">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_copyRemoteDir" class="summary-sig-name" onclick="show_private();">_copyRemoteDir</a>(<span class="summary-sig-arg">remoteUser</span>,
<span class="summary-sig-arg">localUser</span>,
<span class="summary-sig-arg">remoteHost</span>,
<span class="summary-sig-arg">rcpCommand</span>,
<span class="summary-sig-arg">rcpCommandList</span>,
<span class="summary-sig-arg">sourceDir</span>,
<span class="summary-sig-arg">targetDir</span>,
<span class="summary-sig-arg">ownership</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">permissions</span>=<span class="summary-sig-default">None</span>)</span><br />
Copies files from the source directory to the target directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._copyRemoteDir">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_copyRemoteFile" class="summary-sig-name" onclick="show_private();">_copyRemoteFile</a>(<span class="summary-sig-arg">remoteUser</span>,
<span class="summary-sig-arg">localUser</span>,
<span class="summary-sig-arg">remoteHost</span>,
<span class="summary-sig-arg">rcpCommand</span>,
<span class="summary-sig-arg">rcpCommandList</span>,
<span class="summary-sig-arg">sourceFile</span>,
<span class="summary-sig-arg">targetFile</span>,
<span class="summary-sig-arg">ownership</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">permissions</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">overwrite</span>=<span class="summary-sig-default">True</span>)</span><br />
Copies a remote source file to a target file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._copyRemoteFile">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_pushLocalFile" class="summary-sig-name" onclick="show_private();">_pushLocalFile</a>(<span class="summary-sig-arg">remoteUser</span>,
<span class="summary-sig-arg">localUser</span>,
<span class="summary-sig-arg">remoteHost</span>,
<span class="summary-sig-arg">rcpCommand</span>,
<span class="summary-sig-arg">rcpCommandList</span>,
<span class="summary-sig-arg">sourceFile</span>,
<span class="summary-sig-arg">targetFile</span>,
<span class="summary-sig-arg">overwrite</span>=<span class="summary-sig-default">True</span>)</span><br />
Copies a local source file to a remote host.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._pushLocalFile">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_executeRemoteCommand" class="summary-sig-name" onclick="show_private();">_executeRemoteCommand</a>(<span class="summary-sig-arg">remoteUser</span>,
<span class="summary-sig-arg">localUser</span>,
<span class="summary-sig-arg">remoteHost</span>,
<span class="summary-sig-arg">rshCommand</span>,
<span class="summary-sig-arg">rshCommandList</span>,
<span class="summary-sig-arg">remoteCommand</span>)</span><br />
Executes a command on the peer via remote shell.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._executeRemoteCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="CedarBackup2.peer.RemotePeer-class.html#_buildCbackCommand" class="summary-sig-name" onclick="show_private();">_buildCbackCommand</a>(<span class="summary-sig-arg">cbackCommand</span>,
<span class="summary-sig-arg">action</span>,
<span class="summary-sig-arg">fullBackup</span>)</span><br />
Builds a Cedar Backup command line for the named action.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._buildCbackCommand">source code</a></span>
</td>
</tr>
</table>
</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 colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</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">
<a href="CedarBackup2.peer.RemotePeer-class.html#name" class="summary-name">name</a><br />
Name of the peer (a valid DNS hostname).
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.peer.RemotePeer-class.html#collectDir" class="summary-name">collectDir</a><br />
Path to the peer's collect directory (an absolute local path).
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.peer.RemotePeer-class.html#remoteUser" class="summary-name">remoteUser</a><br />
Name of the Cedar Backup user on the remote peer.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.peer.RemotePeer-class.html#rcpCommand" class="summary-name">rcpCommand</a><br />
An rcp-compatible copy command to use for copying files.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.peer.RemotePeer-class.html#rshCommand" class="summary-name">rshCommand</a><br />
An rsh-compatible command to use for remote shells to the peer.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.peer.RemotePeer-class.html#cbackCommand" class="summary-name">cbackCommand</a><br />
A chack-compatible command to use for executing managed actions.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.peer.RemotePeer-class.html#workingDir" class="summary-name">workingDir</a><br />
Path to the peer's working directory (an absolute local path).
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.peer.RemotePeer-class.html#localUser" class="summary-name">localUser</a><br />
Name of the Cedar Backup user on the current host.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.peer.RemotePeer-class.html#ignoreFailureMode" class="summary-name">ignoreFailureMode</a><br />
Ignore failure mode for peer.
</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 colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</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">name</span>=<span class="sig-default">None</span>,
<span class="sig-arg">collectDir</span>=<span class="sig-default">None</span>,
<span class="sig-arg">workingDir</span>=<span class="sig-default">None</span>,
<span class="sig-arg">remoteUser</span>=<span class="sig-default">None</span>,
<span class="sig-arg">rcpCommand</span>=<span class="sig-default">None</span>,
<span class="sig-arg">localUser</span>=<span class="sig-default">None</span>,
<span class="sig-arg">rshCommand</span>=<span class="sig-default">None</span>,
<span class="sig-arg">cbackCommand</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ignoreFailureMode</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.__init__">source code</a></span>
</td>
</tr></table>
<p>Initializes a remote backup peer.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (String, must be a valid DNS hostname) - Name of the backup peer</li>
<li><strong class="pname"><code>collectDir</code></strong> (String representing an absolute path on the remote peer) - Path to the peer's collect directory</li>
<li><strong class="pname"><code>workingDir</code></strong> (String representing an absolute path on the current host.) - Working directory that can be used to create temporary files,
etc.</li>
<li><strong class="pname"><code>remoteUser</code></strong> (String representing a username, valid via remote shell to the
peer) - Name of the Cedar Backup user on the remote peer</li>
<li><strong class="pname"><code>localUser</code></strong> (String representing a username, valid on the current host) - Name of the Cedar Backup user on the current host</li>
<li><strong class="pname"><code>rcpCommand</code></strong> (String representing a system command including required arguments) - An rcp-compatible copy command to use for copying files from the
peer</li>
<li><strong class="pname"><code>rshCommand</code></strong> (String representing a system command including required arguments) - An rsh-compatible copy command to use for remote shells to the
peer</li>
<li><strong class="pname"><code>cbackCommand</code></strong> (String representing a system command including required arguments) - A chack-compatible command to use for executing managed actions</li>
<li><strong class="pname"><code>ignoreFailureMode</code></strong> (One of VALID_FAILURE_MODES) - Ignore failure mode for this peer</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If collect directory is not an absolute path</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
<div class="fields"> <p><strong>Note:</strong>
If provided, each command will eventually be parsed into a list of
strings suitable for passing to <code>util.executeCommand</code> in
order to avoid security holes related to shell interpolation.
This parsing will be done by the <a
href="CedarBackup2.util-module.html#splitCommandLine"
class="link">util.splitCommandLine</a> function. See the
documentation for that function for some important notes about its
limitations.
</p>
</div></td></tr></table>
</div>
<a name="stagePeer"></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">stagePeer</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">targetDir</span>,
<span class="sig-arg">ownership</span>=<span class="sig-default">None</span>,
<span class="sig-arg">permissions</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.stagePeer">source code</a></span>
</td>
</tr></table>
<p>Stages data from the peer into the indicated local target
directory.</p>
<p>The target directory must already exist before this method is called.
If passed in, ownership and permissions will be applied to the files that
are copied.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>targetDir</code></strong> (String representing a directory on disk) - Target directory to write data into</li>
<li><strong class="pname"><code>ownership</code></strong> (Tuple of numeric ids <code>(uid, gid)</code>) - Owner and group that the staged files should have</li>
<li><strong class="pname"><code>permissions</code></strong> (UNIX permissions mode, specified in octal (i.e.
<code>0640</code>).) - Permissions that the staged files should have</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Number of files copied from the source directory to the target
directory.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If target directory is not a directory, does not exist or is not
absolute.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If a path cannot be encoded properly.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there were no files to stage (i.e. the directory was empty)</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is an IO error copying a file.</li>
<li><code><strong class='fraise'>OSError</strong></code> - If there is an OS error copying or changing permissions on a file</li>
</ul></dd>
</dl>
<div class="fields"> <strong>Notes:</strong>
<ul class="nomargin-top">
<li>
The returned count of copied files might be inaccurate if some of
the copied files already existed in the staging directory prior to
the copy taking place. We don't clear the staging directory first,
because some extension might also be using it.
</li>
<li>
If you have user/group as strings, call the <a
href="CedarBackup2.util-module.html#getUidGid"
class="link">util.getUidGid</a> function to get the associated
uid/gid as an ownership tuple.
</li>
<li>
Unlike the local peer version of this method, an I/O error might or
might not be raised if the directory is empty. Since we're using a
remote copy method, we just don't have the fine-grained control
over our exceptions that's available when we can look directly at
the filesystem, and we can't control whether the remote copy method
thinks an empty directory is an error.
</li>
</ul>
</div></td></tr></table>
</div>
<a name="checkCollectIndicator"></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">checkCollectIndicator</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">collectIndicator</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.checkCollectIndicator">source code</a></span>
</td>
</tr></table>
<p>Checks the collect indicator in the peer's staging directory.</p>
<p>When a peer has completed collecting its backup files, it will write
an empty indicator file into its collect directory. This method checks
to see whether that indicator has been written. If the remote copy
command fails, we return <code>False</code> as if the file weren't
there.</p>
<p>If you need to, you can override the name of the collect indicator
file by passing in a different name.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>collectIndicator</code></strong> (String representing name of a file in the collect directory) - Name of the collect indicator file to check</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Boolean true/false depending on whether the indicator exists.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If a path cannot be encoded properly.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
Apparently, we can't count on all rcp-compatible implementations to
return sensible errors for some error conditions. As an example,
the <code>scp</code> command in Debian 'woody' returns a zero
(normal) status even when it can't find a host or if the login or
path is invalid. Because of this, the implementation of this
method is rather convoluted.
</p>
</div></td></tr></table>
</div>
<a name="writeStageIndicator"></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">writeStageIndicator</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">stageIndicator</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.writeStageIndicator">source code</a></span>
</td>
</tr></table>
<p>Writes the stage indicator in the peer's staging directory.</p>
<p>When the master has completed collecting its backup files, it will
write an empty indicator file into the peer's collect directory. The
presence of this file implies that the staging process is complete.</p>
<p>If you need to, you can override the name of the stage indicator file
by passing in a different name.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>stageIndicator</code></strong> (String representing name of a file in the collect directory) - Name of the indicator file to write</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If a path cannot be encoded properly.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is an IO error creating the file.</li>
<li><code><strong class='fraise'>OSError</strong></code> - If there is an OS error creating or changing permissions on the
file</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
If you have user/group as strings, call the <a
href="CedarBackup2.util-module.html#getUidGid"
class="link">util.getUidGid</a> function to get the associated
uid/gid as an ownership tuple.
</p>
</div></td></tr></table>
</div>
<a name="executeRemoteCommand"></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">executeRemoteCommand</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="CedarBackup2.peer-pysrc.html#RemotePeer.executeRemoteCommand">source code</a></span>
</td>
</tr></table>
<p>Executes a command on the peer via remote shell.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>command</code></strong> (String command-line suitable for use with rsh.) - Command to execute</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an error executing the command on the remote peer.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="executeManagedAction"></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">executeManagedAction</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">action</span>,
<span class="sig-arg">fullBackup</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer.executeManagedAction">source code</a></span>
</td>
</tr></table>
<p>Executes a managed action on this peer.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>action</code></strong> - Name of the action to execute.</li>
<li><strong class="pname"><code>fullBackup</code></strong> - Whether a full backup should be executed.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an error executing the action on the remote peer.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_getDirContents"></a>
<div class="private">
<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">_getDirContents</span>(<span class="sig-arg">path</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._getDirContents">source code</a></span>
</td>
</tr></table>
<p>Returns the contents of a directory in terms of a Set.</p>
<p>The directory's contents are read as a <a
href="CedarBackup2.filesystem.FilesystemList-class.html"
class="link">FilesystemList</a> containing only files, and then the list
is converted into a set object for later use.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (String representing a path on disk) - Directory path to get contents for</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Set of files in the directory</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If path is not a directory or does not exist.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_copyRemoteDir"></a>
<div class="private">
<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">_copyRemoteDir</span>(<span class="sig-arg">remoteUser</span>,
<span class="sig-arg">localUser</span>,
<span class="sig-arg">remoteHost</span>,
<span class="sig-arg">rcpCommand</span>,
<span class="sig-arg">rcpCommandList</span>,
<span class="sig-arg">sourceDir</span>,
<span class="sig-arg">targetDir</span>,
<span class="sig-arg">ownership</span>=<span class="sig-default">None</span>,
<span class="sig-arg">permissions</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._copyRemoteDir">source code</a></span>
</td>
</tr></table>
<p>Copies files from the source directory to the target directory.</p>
<p>This function is not recursive. Only the files in the directory will
be copied. Ownership and permissions will be left at their default
values if new values are not specified. Behavior when copying soft links
from the collect directory is dependent on the behavior of the specified
rcp command.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>remoteUser</code></strong> (String representing a username, valid via the copy command) - Name of the Cedar Backup user on the remote peer</li>
<li><strong class="pname"><code>localUser</code></strong> (String representing a username, valid on the current host) - Name of the Cedar Backup user on the current host</li>
<li><strong class="pname"><code>remoteHost</code></strong> (String representing a hostname, accessible via the copy command) - Hostname of the remote peer</li>
<li><strong class="pname"><code>rcpCommand</code></strong> (String representing a system command including required arguments) - An rcp-compatible copy command to use for copying files from the
peer</li>
<li><strong class="pname"><code>rcpCommandList</code></strong> (Command as a list to be passed to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a>) - An rcp-compatible copy command to use for copying files</li>
<li><strong class="pname"><code>sourceDir</code></strong> (String representing a directory on disk) - Source directory</li>
<li><strong class="pname"><code>targetDir</code></strong> (String representing a directory on disk) - Target directory</li>
<li><strong class="pname"><code>ownership</code></strong> (Tuple of numeric ids <code>(uid, gid)</code>) - Owner and group that the copied files should have</li>
<li><strong class="pname"><code>permissions</code></strong> (UNIX permissions mode, specified in octal (i.e.
<code>0640</code>).) - Permissions that the staged files should have</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Number of files copied from the source directory to the target
directory.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If source or target is not a directory or does not exist.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is an IO error copying the files.</li>
</ul></dd>
</dl>
<div class="fields"> <strong>Notes:</strong>
<ul class="nomargin-top">
<li>
The returned count of copied files might be inaccurate if some of
the copied files already existed in the staging directory prior to
the copy taking place. We don't clear the staging directory first,
because some extension might also be using it.
</li>
<li>
If you have user/group as strings, call the <a
href="CedarBackup2.util-module.html#getUidGid"
class="link">util.getUidGid</a> function to get the associated
uid/gid as an ownership tuple.
</li>
<li>
We don't have a good way of knowing exactly what files we copied
down from the remote peer, unless we want to parse the output of
the rcp command (ugh). We could change permissions on everything
in the target directory, but that's kind of ugly too. Instead, we
use Python's set functionality to figure out what files were added
while we executed the rcp command. This isn't perfect - for
instance, it's not correct if someone else is messing with the
directory at the same time we're doing the remote copy - but it's
about as good as we're going to get.
</li>
<li>
Apparently, we can't count on all rcp-compatible implementations to
return sensible errors for some error conditions. As an example,
the <code>scp</code> command in Debian 'woody' returns a zero
(normal) status even when it can't find a host or if the login or
path is invalid. We try to work around this by issuing
<code>IOError</code> if we don't copy any files from the remote
host.
</li>
</ul>
</div></td></tr></table>
</div>
<a name="_copyRemoteFile"></a>
<div class="private">
<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">_copyRemoteFile</span>(<span class="sig-arg">remoteUser</span>,
<span class="sig-arg">localUser</span>,
<span class="sig-arg">remoteHost</span>,
<span class="sig-arg">rcpCommand</span>,
<span class="sig-arg">rcpCommandList</span>,
<span class="sig-arg">sourceFile</span>,
<span class="sig-arg">targetFile</span>,
<span class="sig-arg">ownership</span>=<span class="sig-default">None</span>,
<span class="sig-arg">permissions</span>=<span class="sig-default">None</span>,
<span class="sig-arg">overwrite</span>=<span class="sig-default">True</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._copyRemoteFile">source code</a></span>
</td>
</tr></table>
<p>Copies a remote source file to a target file.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>remoteUser</code></strong> (String representing a username, valid via the copy command) - Name of the Cedar Backup user on the remote peer</li>
<li><strong class="pname"><code>remoteHost</code></strong> (String representing a hostname, accessible via the copy command) - Hostname of the remote peer</li>
<li><strong class="pname"><code>localUser</code></strong> (String representing a username, valid on the current host) - Name of the Cedar Backup user on the current host</li>
<li><strong class="pname"><code>rcpCommand</code></strong> (String representing a system command including required arguments) - An rcp-compatible copy command to use for copying files from the
peer</li>
<li><strong class="pname"><code>rcpCommandList</code></strong> (Command as a list to be passed to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a>) - An rcp-compatible copy command to use for copying files</li>
<li><strong class="pname"><code>sourceFile</code></strong> (String representing a file on disk, as an absolute path) - Source file to copy</li>
<li><strong class="pname"><code>targetFile</code></strong> (String representing a file on disk, as an absolute path) - Target file to create</li>
<li><strong class="pname"><code>ownership</code></strong> (Tuple of numeric ids <code>(uid, gid)</code>) - Owner and group that the copied should have</li>
<li><strong class="pname"><code>permissions</code></strong> (UNIX permissions mode, specified in octal (i.e.
<code>0640</code>).) - Permissions that the staged files should have</li>
<li><strong class="pname"><code>overwrite</code></strong> (Boolean true/false.) - Indicates whether it's OK to overwrite the target file.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If the target file already exists.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is an IO error copying the file</li>
<li><code><strong class='fraise'>OSError</strong></code> - If there is an OS error changing permissions on the file</li>
</ul></dd>
</dl>
<div class="fields"> <strong>Notes:</strong>
<ul class="nomargin-top">
<li>
Internally, we have to go through and escape any spaces in the
source path with double-backslash, otherwise things get screwed up.
It doesn't seem to be required in the target path. I hope this is
portable to various different rcp methods, but I guess it might not
be (all I have to test with is OpenSSH).
</li>
<li>
If you have user/group as strings, call the <a
href="CedarBackup2.util-module.html#getUidGid"
class="link">util.getUidGid</a> function to get the associated
uid/gid as an ownership tuple.
</li>
<li>
We will not overwrite a target file that exists when this method is
invoked. If the target already exists, we'll raise an exception.
</li>
<li>
Apparently, we can't count on all rcp-compatible implementations to
return sensible errors for some error conditions. As an example,
the <code>scp</code> command in Debian 'woody' returns a zero
(normal) status even when it can't find a host or if the login or
path is invalid. We try to work around this by issuing
<code>IOError</code> the target file does not exist when we're
done.
</li>
</ul>
</div></td></tr></table>
</div>
<a name="_pushLocalFile"></a>
<div class="private">
<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">_pushLocalFile</span>(<span class="sig-arg">remoteUser</span>,
<span class="sig-arg">localUser</span>,
<span class="sig-arg">remoteHost</span>,
<span class="sig-arg">rcpCommand</span>,
<span class="sig-arg">rcpCommandList</span>,
<span class="sig-arg">sourceFile</span>,
<span class="sig-arg">targetFile</span>,
<span class="sig-arg">overwrite</span>=<span class="sig-default">True</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._pushLocalFile">source code</a></span>
</td>
</tr></table>
<p>Copies a local source file to a remote host.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>remoteUser</code></strong> (String representing a username, valid via the copy command) - Name of the Cedar Backup user on the remote peer</li>
<li><strong class="pname"><code>localUser</code></strong> (String representing a username, valid on the current host) - Name of the Cedar Backup user on the current host</li>
<li><strong class="pname"><code>remoteHost</code></strong> (String representing a hostname, accessible via the copy command) - Hostname of the remote peer</li>
<li><strong class="pname"><code>rcpCommand</code></strong> (String representing a system command including required arguments) - An rcp-compatible copy command to use for copying files from the
peer</li>
<li><strong class="pname"><code>rcpCommandList</code></strong> (Command as a list to be passed to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a>) - An rcp-compatible copy command to use for copying files</li>
<li><strong class="pname"><code>sourceFile</code></strong> (String representing a file on disk, as an absolute path) - Source file to copy</li>
<li><strong class="pname"><code>targetFile</code></strong> (String representing a file on disk, as an absolute path) - Target file to create</li>
<li><strong class="pname"><code>overwrite</code></strong> (Boolean true/false.) - Indicates whether it's OK to overwrite the target file.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an IO error copying the file</li>
<li><code><strong class='fraise'>OSError</strong></code> - If there is an OS error changing permissions on the file</li>
</ul></dd>
</dl>
<div class="fields"> <strong>Notes:</strong>
<ul class="nomargin-top">
<li>
We will not overwrite a target file that exists when this method is
invoked. If the target already exists, we'll raise an exception.
</li>
<li>
Internally, we have to go through and escape any spaces in the
source and target paths with double-backslash, otherwise things get
screwed up. I hope this is portable to various different rcp
methods, but I guess it might not be (all I have to test with is
OpenSSH).
</li>
<li>
If you have user/group as strings, call the <a
href="CedarBackup2.util-module.html#getUidGid"
class="link">util.getUidGid</a> function to get the associated
uid/gid as an ownership tuple.
</li>
</ul>
</div></td></tr></table>
</div>
<a name="_setName"></a>
<div class="private">
<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">_setName</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setName">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the peer name. The value must be a
non-empty string and cannot be <code>None</code>.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is an empty string or <code>None</code>.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setCollectDir"></a>
<div class="private">
<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">_setCollectDir</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setCollectDir">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the collect directory. The value must be
an absolute path and cannot be <code>None</code>. It does not have to
exist on disk at the time of assignment.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is <code>None</code> or is not an absolute path.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If the value cannot be encoded properly.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setWorkingDir"></a>
<div class="private">
<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">_setWorkingDir</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setWorkingDir">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the working directory. The value must be
an absolute path and cannot be <code>None</code>.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is <code>None</code> or is not an absolute path.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If the value cannot be encoded properly.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setRemoteUser"></a>
<div class="private">
<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">_setRemoteUser</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setRemoteUser">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the remote user. The value must be a
non-empty string and cannot be <code>None</code>.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is an empty string or <code>None</code>.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setLocalUser"></a>
<div class="private">
<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">_setLocalUser</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setLocalUser">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the local user. The value must be a
non-empty string if it is not <code>None</code>.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is an empty string.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setRcpCommand"></a>
<div class="private">
<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">_setRcpCommand</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setRcpCommand">source code</a></span>
</td>
</tr></table>
<p>Property target to set the rcp command.</p>
<p>The value must be a non-empty string or <code>None</code>. Its value
is stored in the two forms: "raw" as provided by the client,
and "parsed" into a list suitable for being passed to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> via <a
href="CedarBackup2.util-module.html#splitCommandLine"
class="link">util.splitCommandLine</a>.</p>
<p>However, all the caller will ever see via the property is the actual
value they set (which includes seeing <code>None</code>, even if we
translate that internally to <code>DEF_RCP_COMMAND</code>). Internally,
we should always use <code>self._rcpCommandList</code> if we want the
actual command list.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is an empty string.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setRshCommand"></a>
<div class="private">
<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">_setRshCommand</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setRshCommand">source code</a></span>
</td>
</tr></table>
<p>Property target to set the rsh command.</p>
<p>The value must be a non-empty string or <code>None</code>. Its value
is stored in the two forms: "raw" as provided by the client,
and "parsed" into a list suitable for being passed to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> via <a
href="CedarBackup2.util-module.html#splitCommandLine"
class="link">util.splitCommandLine</a>.</p>
<p>However, all the caller will ever see via the property is the actual
value they set (which includes seeing <code>None</code>, even if we
translate that internally to <code>DEF_RSH_COMMAND</code>). Internally,
we should always use <code>self._rshCommandList</code> if we want the
actual command list.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is an empty string.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setCbackCommand"></a>
<div class="private">
<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">_setCbackCommand</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setCbackCommand">source code</a></span>
</td>
</tr></table>
<p>Property target to set the cback command.</p>
<p>The value must be a non-empty string or <code>None</code>. Unlike the
other command, this value is only stored in the "raw" form
provided by the client.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is an empty string.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setIgnoreFailureMode"></a>
<div class="private">
<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">_setIgnoreFailureMode</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._setIgnoreFailureMode">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the ignoreFailure mode. If not
<code>None</code>, the mode must be one of the values in
VALID_FAILURE_MODES.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is not valid.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_executeRemoteCommand"></a>
<div class="private">
<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">_executeRemoteCommand</span>(<span class="sig-arg">remoteUser</span>,
<span class="sig-arg">localUser</span>,
<span class="sig-arg">remoteHost</span>,
<span class="sig-arg">rshCommand</span>,
<span class="sig-arg">rshCommandList</span>,
<span class="sig-arg">remoteCommand</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._executeRemoteCommand">source code</a></span>
</td>
</tr></table>
<p>Executes a command on the peer via remote shell.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>remoteUser</code></strong> (String representing a username, valid on the remote host) - Name of the Cedar Backup user on the remote peer</li>
<li><strong class="pname"><code>localUser</code></strong> (String representing a username, valid on the current host) - Name of the Cedar Backup user on the current host</li>
<li><strong class="pname"><code>remoteHost</code></strong> (String representing a hostname, accessible via the copy command) - Hostname of the remote peer</li>
<li><strong class="pname"><code>rshCommand</code></strong> (String representing a system command including required arguments) - An rsh-compatible copy command to use for remote shells to the
peer</li>
<li><strong class="pname"><code>rshCommandList</code></strong> (Command as a list to be passed to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a>) - An rsh-compatible copy command to use for remote shells to the
peer</li>
<li><strong class="pname"><code>remoteCommand</code></strong> (String command-line, with no special shell characters ($, <,
etc.)) - The command to be executed on the remote host</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an error executing the remote command</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_buildCbackCommand"></a>
<div class="private">
<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">_buildCbackCommand</span>(<span class="sig-arg">cbackCommand</span>,
<span class="sig-arg">action</span>,
<span class="sig-arg">fullBackup</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.peer-pysrc.html#RemotePeer._buildCbackCommand">source code</a></span>
</td>
</tr></table>
<p>Builds a Cedar Backup command line for the named action.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>cbackCommand</code></strong> - cback command to execute, including required options</li>
<li><strong class="pname"><code>action</code></strong> - Name of the action to execute.</li>
<li><strong class="pname"><code>fullBackup</code></strong> - Whether a full backup should be executed.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>String suitable for passing to <a
href="CedarBackup2.peer.RemotePeer-class.html#_executeRemoteCommand"
class="link" onclick="show_private();">_executeRemoteCommand</a>
as remoteCommand.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If action is None.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
If the cback command is None, then DEF_CBACK_COMMAND is used.
</p>
</div></td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Property Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-PropertyDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">name</h3>
<p>Name of the peer (a valid DNS hostname).</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getName" class="summary-sig-name" onclick="show_private();">_getName</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the peer name.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setName" class="summary-sig-name" onclick="show_private();">_setName</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the peer name.
</dd>
</dl>
</td></tr></table>
</div>
<a name="collectDir"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">collectDir</h3>
<p>Path to the peer's collect directory (an absolute local path).</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getCollectDir" class="summary-sig-name" onclick="show_private();">_getCollectDir</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the collect directory.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setCollectDir" class="summary-sig-name" onclick="show_private();">_setCollectDir</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the collect directory.
</dd>
</dl>
</td></tr></table>
</div>
<a name="remoteUser"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">remoteUser</h3>
<p>Name of the Cedar Backup user on the remote peer.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getRemoteUser" class="summary-sig-name" onclick="show_private();">_getRemoteUser</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the remote user.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setRemoteUser" class="summary-sig-name" onclick="show_private();">_setRemoteUser</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the remote user.
</dd>
</dl>
</td></tr></table>
</div>
<a name="rcpCommand"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">rcpCommand</h3>
<p>An rcp-compatible copy command to use for copying files.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getRcpCommand" class="summary-sig-name" onclick="show_private();">_getRcpCommand</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the rcp command.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setRcpCommand" class="summary-sig-name" onclick="show_private();">_setRcpCommand</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target to set the rcp command.
</dd>
</dl>
</td></tr></table>
</div>
<a name="rshCommand"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">rshCommand</h3>
<p>An rsh-compatible command to use for remote shells to the peer.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getRshCommand" class="summary-sig-name" onclick="show_private();">_getRshCommand</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the rsh command.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setRshCommand" class="summary-sig-name" onclick="show_private();">_setRshCommand</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target to set the rsh command.
</dd>
</dl>
</td></tr></table>
</div>
<a name="cbackCommand"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">cbackCommand</h3>
<p>A chack-compatible command to use for executing managed actions.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getCbackCommand" class="summary-sig-name" onclick="show_private();">_getCbackCommand</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the cback command.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setCbackCommand" class="summary-sig-name" onclick="show_private();">_setCbackCommand</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target to set the cback command.
</dd>
</dl>
</td></tr></table>
</div>
<a name="workingDir"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">workingDir</h3>
<p>Path to the peer's working directory (an absolute local path).</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getWorkingDir" class="summary-sig-name" onclick="show_private();">_getWorkingDir</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the working directory.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setWorkingDir" class="summary-sig-name" onclick="show_private();">_setWorkingDir</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the working directory.
</dd>
</dl>
</td></tr></table>
</div>
<a name="localUser"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">localUser</h3>
<p>Name of the Cedar Backup user on the current host.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getLocalUser" class="summary-sig-name" onclick="show_private();">_getLocalUser</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the local user.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setLocalUser" class="summary-sig-name" onclick="show_private();">_setLocalUser</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the local user.
</dd>
</dl>
</td></tr></table>
</div>
<a name="ignoreFailureMode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">ignoreFailureMode</h3>
<p>Ignore failure mode for peer.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_getIgnoreFailureMode" class="summary-sig-name" onclick="show_private();">_getIgnoreFailureMode</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the ignoreFailure mode.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.peer.RemotePeer-class.html#_setIgnoreFailureMode" class="summary-sig-name" onclick="show_private();">_setIgnoreFailureMode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the ignoreFailure mode.
</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="CedarBackup2-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>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></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 Tue Oct 19 20:56:44 2010
</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>
|
