forked from lilydjwg/pssh
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
582 lines (571 loc) · 9.35 KB
/
index.html
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
<HTML
><HEAD
><TITLE
>pssh HOWTO</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"></HEAD
><BODY
CLASS="ARTICLE"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="ARTICLE"
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="TITLE"
><A
NAME="AEN2">pssh HOWTO</H1
><DIV
CLASS="AUTHORGROUP"
><A
NAME="AEN5"><H3
CLASS="AUTHOR"
><A
NAME="AEN6"
>Brent Chun</A
></H3
></DIV
><P
CLASS="PUBDATE"
>0.1, 2003-11-13<BR></P
><DIV
CLASS="REVHISTORY"
><TABLE
WIDTH="100%"
BORDER="0"
><TR
><TH
ALIGN="LEFT"
VALIGN="TOP"
COLSPAN="3"
><B
>Revision History</B
></TH
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 0.1</TD
><TD
ALIGN="LEFT"
>2003-11-13</TD
><TD
ALIGN="LEFT"
></TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Initial version.</TD
></TR
></TABLE
></DIV
><DIV
><DIV
CLASS="ABSTRACT"
><A
NAME="AEN14"><P
></P
><P
> </P
><P
></P
></DIV
></DIV
><HR></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>1. <A
HREF="#AEN16"
>Installation and Setup</A
></DT
><DT
>2. <A
HREF="#AEN26"
>Preliminaries</A
></DT
><DT
>3. <A
HREF="#AEN38"
>Examples</A
></DT
><DD
><DL
><DT
>3.1. <A
HREF="#AEN40"
>pssh</A
></DT
><DT
>3.2. <A
HREF="#AEN55"
>pscp</A
></DT
><DT
>3.3. <A
HREF="#AEN61"
>pnuke</A
></DT
></DL
></DD
><DT
>4. <A
HREF="#AEN72"
>Environment Variables</A
></DT
><DT
>5. <A
HREF="#AEN80"
>Feedback</A
></DT
></DL
></DIV
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN16">1. Installation and Setup</H2
><P
> To install the software, become <TT
CLASS="CONSTANT"
>root</TT
> on your machine and do
the following (on RedHat systems):
</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # rpm -ivh pssh-0.2.3-1.i386.rpm
Preparing... ########################################### [100%]
1:pssh ########################################### [100%]</PRE
></FONT
></TD
></TR
></TABLE
><P
> By default, the software installs itself in <TT
CLASS="CONSTANT"
>/usr/localbin</TT
> and
<TT
CLASS="CONSTANT"
>/usr/local/lib</TT
>. Thus, you'll next want to
modify your <TT
CLASS="CONSTANT"
>PATH</TT
> if needed:
</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
># export PATH=$PATH:/usr/local/bin</PRE
></FONT
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN26">2. Preliminaries</H2
><P
>All four programs will print their usage and give an example
if no arguments are given. For example, with <TT
CLASS="CONSTANT"
>pssh</TT
>:
</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # pssh
Usage: pssh [OPTIONS] -h hosts.txt prog [arg0] ..
-h --hosts hosts file (each line "host[:port] [user]")
-l --user username (OPTIONAL)
-p --par max number of parallel threads (OPTIONAL)
-o --outdir output directory for stdout files (OPTIONAL)
-t --timeout timeout in seconds to do ssh to a host (OPTIONAL)
-v --verbose turn on warning and diagnostic messages (OPTIONAL)
-O --options SSH options (OPTIONAL)
Example: pssh -h ips.txt -l irb2 -o /tmp/foo uptime</PRE
></FONT
></TD
></TR
></TABLE
><P
>And for <TT
CLASS="CONSTANT"
>pscp</TT
>:</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # pscp
Usage: pscp [OPTIONS] -h hosts.txt local remote
-h --hosts hosts file (each line "host[:port] [login]")
-r --recursive recusively copy directories (OPTIONAL)
-l --user username (OPTIONAL)
-p --par max number of parallel threads (OPTIONAL)
-t --timeout timeout in seconds to do scp to a host (OPTIONAL)
-O --options SSH options (OPTIONAL)
Example: pscp -h hosts.txt -l irb2 foo.txt /home/irb2/foo.txt</PRE
></FONT
></TD
></TR
></TABLE
><P
>Note that before using any of these tools, you <EM
>will need to start
ssh-agent</EM
>! This can be done as follows (substitute <TT
CLASS="CONSTANT"
>zsh</TT
>
with your particular shell).</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # ssh-agent zsh
# ssh-add
Enter passphrase for /x/bnc/.ssh/identity: </PRE
></FONT
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN38">3. Examples</H2
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
NAME="AEN40">3.1. pssh</H3
><P
>The following example runs <TT
CLASS="CONSTANT"
>hostname</TT
> on three machines (IPs
or hostnames) specified in the file <TT
CLASS="CONSTANT"
>ips.txt</TT
> using login
<TT
CLASS="CONSTANT"
>irb2</TT
> and saves the output in <TT
CLASS="CONSTANT"
>/tmp/foo</TT
>. </P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # cat ips.txt
128.112.152.122
18.31.0.190
128.232.103.201
# pssh -h ips.txt -l irb2 -o /tmp/foo hostname
Success on 128.112.152.122:22
Success on 18.31.0.190:22
Success on 128.232.103.201:22
# ls /tmp/foo
128.112.152.122 128.232.103.201 18.31.0.190
# cat /tmp/foo/*
planetlab-1.cs.princeton.edu
planetlab1.xeno.cl.cam.ac.uk
planetlab1.lcs.mit.edu</PRE
></FONT
></TD
></TR
></TABLE
><P
>By default, <TT
CLASS="CONSTANT"
>pssh</TT
> uses at most 32 ssh processes in parallel to
ssh to the various nodes. (This is somewhat important if you're
controlling hundreds or thousands of machines.) By default, it also
uses a timeout of one minute to ssh to a node and obtain a result.
For ssh commands that take longer than this (e.g., <TT
CLASS="CONSTANT"
>sleep 61</TT
>),
the -t option can be used. Note that <TT
CLASS="CONSTANT"
>pssh</TT
> and
<TT
CLASS="CONSTANT"
>pnuke</TT
>
have a default timeout of one minute.
<TT
CLASS="CONSTANT"
>pscp</TT
> and <TT
CLASS="CONSTANT"
>prsync</TT
> have no default timeout, but
one can be specified using the -t option.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN55">3.2. pscp</H3
><P
>Here's an example of using <TT
CLASS="CONSTANT"
>pscp</TT
> to copy files in parallel to
a set of machines.</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # pscp -h ips.txt -l irb2 /etc/hosts /tmp/hosts
Success on 128.112.152.122:22
Success on 18.31.0.190:22
Success on 128.232.103.201:22</PRE
></FONT
></TD
></TR
></TABLE
><P
>Using the -r option will perform a recursive copy for copying
entire directories.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN61">3.3. pnuke</H3
><P
>The <TT
CLASS="CONSTANT"
>pnuke</TT
> command is useful when you want to kill a bunch of
processes on a set of machines. For example, suppose you've got a
bunch of <TT
CLASS="CONSTANT"
>java</TT
> processes running on three nodes that
you'd like to nuke (let's use the three machines from the <TT
CLASS="CONSTANT"
>pssh</TT
>
example). Here you would do the following:</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # pnuke -h ips.txt -l irb2 java
Success on 128.112.152.122:22
Success on 18.31.0.190:22
Success on 128.232.103.201:22</PRE
></FONT
></TD
></TR
></TABLE
><P
>The result of the above is to send <TT
CLASS="CONSTANT"
>kill -9</TT
> to all processes
owned by <TT
CLASS="CONSTANT"
>irb2</TT
> with the string java in their name (as reported
by <TT
CLASS="CONSTANT"
>ps -ef</TT
>).</P
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN72">4. Environment Variables</H2
><P
>All four programs take similar sets of options. All of these
options can be set using the following environment variables:</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> PSSH_HOSTS
PSSH_USER
PSSH_PAR
PSSH_OUTDIR
PSSH_VERBOSE
PSSH_OPTIONS</PRE
></FONT
></TD
></TR
></TABLE
><P
>Here are some example settings:</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # export PSSH_HOSTS="/x/bnc/ips.txt"
# export PSSH_USER="irb2"
# export PSSH_PAR="32"
# export PSSH_OUTDIR="/tmp/bar"
# export PSSH_VERBOSE="0"
# export PSSH_OPTIONS="UserKnownHostsFile /tmp/known_hosts"</PRE
></FONT
></TD
></TR
></TABLE
><P
>Using the above settings, the examples can be executed succinctly as:</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
> # pssh hostname
Success on 128.112.152.122:22
Success on 18.31.0.190:22
Success on 128.232.103.201:22
# ls /tmp/bar
128.112.152.122 128.232.103.201 18.31.0.190
# cat /tmp/bar/*
planetlab-1.cs.princeton.edu
planetlab1.xeno.cl.cam.ac.uk
planetlab1.lcs.mit.edu
# pscp /etc/hosts /tmp/hosts
Success on 128.112.152.122:22
Success on 18.31.0.190:22
Success on 128.232.103.201:22
# pnuke java
Success on 128.112.152.122:22
Success on 18.31.0.190:22
Success on 128.232.103.201:22</PRE
></FONT
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN80">5. Feedback</H2
><P
>Send me email if you're having problems, find bugs, or have any random
comments: <A
HREF="http://www.theether.org"
TARGET="_top"
>Brent Chun</A
>
(bnc at theether.org). Thus
far, I've primarily been testing this software on <A
HREF="http://www.planet-lab.org"
TARGET="_top"
>PlanetLab</A
>.</P
></DIV
></DIV
></BODY
></HTML
>