1SHEEPDOG(8) System Manager's Manual SHEEPDOG(8)
2
6 dog - Command line utility for the sheep daemon
7
9 dog <command> <subcommand> [options]
10
12 dog - Sheepdog is a distributed storage system for QEMU. It provides
13 highly available block level storage volumes to virtual machines.
14 Sheepdog supports advanced volume management features such as snapshot,
15 cloning, and thin provisioning. The architecture of Sheepdog is fully
16 symmetric; there is no central node such as a meta-data server.
17 The server daemon is called sheep(8). A command line utility is avail‐
19 able via dog(8). QEMU virtual machines use the sheep daemon via a
20 block driver available in qemu(1).
21 For more information, run 'dog <command> <subcommand> --help'.
23
25 vdi check [-s snapshot] [-e] [-a address] [-p port] [-h] [-T] <vdiname>
26 Options:
28 -s, --snapshot specify a snapshot id or tag name
29 -e, --exist only check objects exist or not,
30 neither comparing nor repairing
31 -a, --address specify the daemon address (default:
32 localhost)
33 -p, --port specify the daemon port
34 -h, --help display this help and exit
35 -T, --time show elapsed time
36 Description:
38 check and repair image's consistency
39 vdi create [-P] [-y] [-c copies] [-a address] [-p port] [-h] [-r] [-v]
41 [-z block_size_shift] [-T] <vdiname> <size>
42 Options:
44 -P, --prealloc preallocate all the data objects
45 -y, --hyper create a hyper volume
46 -c, --copies specify the data redundancy level
47 -a, --address specify the daemon address (default:
48 localhost)
49 -p, --port specify the daemon port
50 -h, --help display this help and exit
51 -r, --raw raw output mode: omit headers, sepa‐
52 rate fields with
53 single spaces and print all sizes in
54 decimal bytes
55 -v, --verbose print more information than default
56 -z, --block_size_shift specify the bit shift num for data ob‐
57 ject size
58 -T, --time show elapsed time
59 Description:
61 create an image
62 vdi snapshot [-s snapshot] [-a address] [-p port] [-h] [-r] [-v] [-T]
64 [-R] <vdiname>
65 Options:
67 -s, --snapshot specify a snapshot id or tag name
68 -a, --address specify the daemon address (default:
69 localhost)
70 -p, --port specify the daemon port
71 -h, --help display this help and exit
72 -r, --raw raw output mode: omit headers, sepa‐
73 rate fields with
74 single spaces and print all sizes in
75 decimal bytes
76 -v, --verbose print more information than default
77 -T, --time show elapsed time
78 -R, --reduce-identical-snapshotsdo not create snapshot if
79 working VDI doesn't have its own objects
80 Description:
82 create a snapshot
83 vdi clone [-s snapshot] [-P] [-n] [-a address] [-p port] [-h] [-r] [-v]
85 [-T] <src vdi> <dst vdi>
86 Options:
88 -s, --snapshot specify a snapshot id or tag name
89 -P, --prealloc preallocate all the data objects
90 -n, --no-share share nothing with its parent
91 -a, --address specify the daemon address (default:
92 localhost)
93 -p, --port specify the daemon port
94 -h, --help display this help and exit
95 -r, --raw raw output mode: omit headers, sepa‐
96 rate fields with
97 single spaces and print all sizes in
98 decimal bytes
99 -v, --verbose print more information than default
100 -T, --time show elapsed time
101 Description:
103 clone an image
104 vdi delete [-s snapshot] [-a address] [-p port] [-h] [-T] <vdiname>
106 Options:
108 -s, --snapshot specify a snapshot id or tag name
109 -a, --address specify the daemon address (default:
110 localhost)
111 -p, --port specify the daemon port
112 -h, --help display this help and exit
113 -T, --time show elapsed time
114 Description:
116 delete an image
117 vdi rollback [-s snapshot] [-a address] [-p port] [-h] [-f] [-r] [-v]
119 [-T] <vdiname>
120 Options:
122 -s, --snapshot specify a snapshot id or tag name
123 -a, --address specify the daemon address (default:
124 localhost)
125 -p, --port specify the daemon port
126 -h, --help display this help and exit
127 -f, --force do operation forcibly
128 -r, --raw raw output mode: omit headers, sepa‐
129 rate fields with
130 single spaces and print all sizes in
131 decimal bytes
132 -v, --verbose print more information than default
133 -T, --time show elapsed time
134 Description:
136 rollback to a snapshot
137 vdi list [-a address] [-p port] [-r] [-h] [-o oid] [-T] [vdiname]
139 Options:
141 -a, --address specify the daemon address (default:
142 localhost)
143 -p, --port specify the daemon port
144 -r, --raw raw output mode: omit headers, sepa‐
145 rate fields with
146 single spaces and print all sizes in
147 decimal bytes
148 -h, --help display this help and exit
149 -o, --oid specify the object id of the tracking
150 object
151 -T, --time show elapsed time
152 Description:
154 list images
155 vdi tree [-a address] [-p port] [-h] [-T]
157 Options:
159 -a, --address specify the daemon address (default:
160 localhost)
161 -p, --port specify the daemon port
162 -h, --help display this help and exit
163 -T, --time show elapsed time
164 Description:
166 show images in tree view format
167 vdi graph [-a address] [-p port] [-h] [-T]
169 Options:
171 -a, --address specify the daemon address (default:
172 localhost)
173 -p, --port specify the daemon port
174 -h, --help display this help and exit
175 -T, --time show elapsed time
176 Description:
178 show images in Graphviz dot format
179 vdi object {location|map|dump-inode} [-i index] [-s snapshot] [-a ad‐
181 dress] [-p port] [-h] [-T] <vdiname>
182 Available subcommands:
184 location show object location information
185 map show object map information
186 dump-inode dump inode information
187 Options:
189 -i, --index specify the index of data objects
190 -s, --snapshot specify a snapshot id or tag name
191 -a, --address specify the daemon address (default:
192 localhost)
193 -p, --port specify the daemon port
194 -h, --help display this help and exit
195 -T, --time show elapsed time
196 Description:
198 show object information in the image
199 vdi track [-i index] [-s snapshot] [-a address] [-p port] [-h] [-o oid]
201 [-T] <vdiname>
202 Options:
204 -i, --index specify the index of data objects
205 -s, --snapshot specify a snapshot id or tag name
206 -a, --address specify the daemon address (default:
207 localhost)
208 -p, --port specify the daemon port
209 -h, --help display this help and exit
210 -o, --oid specify the object id of the tracking
211 object
212 -T, --time show elapsed time
213 Description:
215 show the object epoch trace in the image
216 vdi setattr [-d] [-x] [-a address] [-p port] [-h] [-T] <vdiname> <key>
218 [value]
219 Options:
221 -d, --delete delete a key
222 -x, --exclusive write in an exclusive mode
223 -a, --address specify the daemon address (default:
224 localhost)
225 -p, --port specify the daemon port
226 -h, --help display this help and exit
227 -T, --time show elapsed time
228 Description:
230 set a VDI attribute
231 vdi getattr [-a address] [-p port] [-h] [-T] <vdiname> <key>
233 Options:
235 -a, --address specify the daemon address (default:
236 localhost)
237 -p, --port specify the daemon port
238 -h, --help display this help and exit
239 -T, --time show elapsed time
240 Description:
242 get a VDI attribute
243 vdi resize [-a address] [-p port] [-h] [-T] <vdiname> <new size>
245 Options:
247 -a, --address specify the daemon address (default:
248 localhost)
249 -p, --port specify the daemon port
250 -h, --help display this help and exit
251 -T, --time show elapsed time
252 Description:
254 resize an image
255 vdi read [-s snapshot] [-a address] [-p port] [-h] [-T] <vdiname>
257 [<offset> [<len>]]
258 Options:
260 -s, --snapshot specify a snapshot id or tag name
261 -a, --address specify the daemon address (default:
262 localhost)
263 -p, --port specify the daemon port
264 -h, --help display this help and exit
265 -T, --time show elapsed time
266 Description:
268 read data from an image
269 vdi write [-a address] [-p port] [-w] [-h] [-T] <vdiname> [<offset>
271 [<len>]]
272 Options:
274 -a, --address specify the daemon address (default:
275 localhost)
276 -p, --port specify the daemon port
277 -w, --writeback use writeback mode
278 -h, --help display this help and exit
279 -T, --time show elapsed time
280 Description:
282 write data to an image
283 vdi backup [-s snapshot] [-F from] [-a address] [-p port] [-h] [-T]
285 <vdiname>
286 Options:
288 -s, --snapshot specify a snapshot id or tag name
289 -F, --from create a differential backup from the
290 snapshot
291 -a, --address specify the daemon address (default:
292 localhost)
293 -p, --port specify the daemon port
294 -h, --help display this help and exit
295 -T, --time show elapsed time
296 Description:
298 create an incremental backup between two snapshots and outputs
299 to STDOUT
300 vdi restore [-s snapshot] [-a address] [-p port] [-h] [-T] <vdiname>
302 Options:
304 -s, --snapshot specify a snapshot id or tag name
305 -a, --address specify the daemon address (default:
306 localhost)
307 -p, --port specify the daemon port
308 -h, --help display this help and exit
309 -T, --time show elapsed time
310 Description:
312 restore snapshot images from a backup provided in STDIN
313 vdi alter-copy [-c copies] [-a address] [-p port] [-h] [-T] [-f] <vdi‐
315 name>
316 Options:
318 -c, --copies specify the data redundancy level
319 -a, --address specify the daemon address (default:
320 localhost)
321 -p, --port specify the daemon port
322 -h, --help display this help and exit
323 -T, --time show elapsed time
324 -f, --force do operation forcibly
325 Description:
327 set the vdi's redundancy level
328 vdi lock {list|unlock} [-s snapshot] [-a address] [-p port] [-h] [-T]
330 Available subcommands:
332 list list locked VDIs
333 unlock unlock locked VDI forcibly
334 Options:
336 -s, --snapshot specify a snapshot id or tag name
337 -a, --address specify the daemon address (default:
338 localhost)
339 -p, --port specify the daemon port
340 -h, --help display this help and exit
341 -T, --time show elapsed time
342 Description:
344 See 'dog vdi lock' for more information
345 node kill [-a address] [-p port] [-r] [-h] [-l] [-T] <node id>
347 Options:
349 -a, --address specify the daemon address (default:
350 localhost)
351 -p, --port specify the daemon port
352 -r, --raw raw output mode: omit headers, sepa‐
353 rate fields with
354 single spaces and print all sizes in
355 decimal bytes
356 -h, --help display this help and exit
357 -l, --local issue request to local node
358 -T, --time show elapsed time
359 Description:
361 kill node
362 node list [-a address] [-p port] [-r] [-h] [-T]
364 Options:
366 -a, --address specify the daemon address (default:
367 localhost)
368 -p, --port specify the daemon port
369 -r, --raw raw output mode: omit headers, sepa‐
370 rate fields with
371 single spaces and print all sizes in
372 decimal bytes
373 -h, --help display this help and exit
374 -T, --time show elapsed time
375 Description:
377 list nodes
378 node info [-a address] [-p port] [-r] [-h] [-T]
380 Options:
382 -a, --address specify the daemon address (default:
383 localhost)
384 -p, --port specify the daemon port
385 -r, --raw raw output mode: omit headers, sepa‐
386 rate fields with
387 single spaces and print all sizes in
388 decimal bytes
389 -h, --help display this help and exit
390 -T, --time show elapsed time
391 Description:
393 show information about each node
394 node recovery {info|set-throttle|get-throttle} [-a address] [-p port]
396 [-h] [-P] [-r] [-T] <max> <interval>
397 Available subcommands:
399 info show recovery information of nodes
400 (default)
401 set-throttle set new throttling
402 get-throttle get current throttling
403 Options:
405 -a, --address specify the daemon address (default:
406 localhost)
407 -p, --port specify the daemon port
408 -h, --help display this help and exit
409 -P, --progress show progress of recovery in the node
410 -r, --raw raw output mode: omit headers, sepa‐
411 rate fields with
412 single spaces and print all sizes in
413 decimal bytes
414 -T, --time show elapsed time
415 Description:
417 show recovery information or set/get recovery speed throttling
418 of nodes
419 node md {info|plug|unplug} [-a address] [-p port] [-r] [-A] [-f] [-h]
421 [-T] [disks]
422 Available subcommands:
424 info show multi-disk information
425 plug plug more disk(s) into node
426 unplug unplug disk(s) from node
427 Options:
429 -a, --address specify the daemon address (default:
430 localhost)
431 -p, --port specify the daemon port
432 -r, --raw raw output mode: omit headers, sepa‐
433 rate fields with
434 single spaces and print all sizes in
435 decimal bytes
436 -A, --all show md information of all the nodes
437 -f, --force ignore the confirmation
438 -h, --help display this help and exit
439 -T, --time show elapsed time
440 Description:
442 See 'dog node md' for more information
443 node stat [-a address] [-p port] [-r] [-w] [-h] [-T]
445 Options:
447 -a, --address specify the daemon address (default:
448 localhost)
449 -p, --port specify the daemon port
450 -r, --raw raw output mode: omit headers, sepa‐
451 rate fields with
452 single spaces and print all sizes in
453 decimal bytes
454 -w, --watch watch the stat every second
455 -h, --help display this help and exit
456 -T, --time show elapsed time
457 Description:
459 show stat information about the node
460 node log level [-a address] [-p port] [-h] [-T]
462 Available subcommands:
464 level manipulate loglevel
465 Options:
467 -a, --address specify the daemon address (default:
468 localhost)
469 -p, --port specify the daemon port
470 -h, --help display this help and exit
471 -T, --time show elapsed time
472 Description:
474 show or set log level of the node
475 node vnodes set [-a address] [-p port] [-h] <num of vnodes>
477 Available subcommands:
479 set set new vnodes
480 Options:
482 -a, --address specify the daemon address (default:
483 localhost)
484 -p, --port specify the daemon port
485 -h, --help display this help and exit
486 Description:
488 set new vnodes
489 node format [-a address] [-p port] [-h] [-T] <directory of sheep> <a
491 name of store format>
492 Options:
494 -a, --address specify the daemon address (default:
495 localhost)
496 -p, --port specify the daemon port
497 -h, --help display this help and exit
498 -T, --time show elapsed time
499 Description:
501 initialize store format of the node
502 cluster info [-a address] [-p port] [-r] [-h] [-v] [-T] [-d]
504 Options:
506 -a, --address specify the daemon address (default:
507 localhost)
508 -p, --port specify the daemon port
509 -r, --raw raw output mode: omit headers, sepa‐
510 rate fields with
511 single spaces and print all sizes in
512 decimal bytes
513 -h, --help display this help and exit
514 -v, --verbose print more information than default
515 -T, --time show elapsed time
516 -d, --diff just output the changes between the
517 two adjacent epochesfor cluster info
518 Description:
520 show cluster information
521 cluster format [-b store] [-c copies] [-l] [-t] [-a address] [-p port]
523 [-h] [-z block_size_shift] [-T] [-V] [-R] [-f] [-F]
524 Options:
526 -b, --store specify backend store
527 -c, --copies specify the default data redundancy
528 (number of copies)
529 -l, --lock Lock vdi to exclude multiple users
530 -t, --strict do not serve write request if number
531 of nodes is not sufficient
532 -a, --address specify the daemon address (default:
533 localhost)
534 -p, --port specify the daemon port
535 -h, --help display this help and exit
536 -z, --block_size_shift specify the shift num of default data
537 object size
538 -T, --time show elapsed time
539 -V, --fixedvnodes disable automatic vnodes calculation
540 -R, --recyclevid enable recycling of VID
541 -f, --force do not prompt for confirmation
542 -F, --avoid-diskfull skip recovery if recovery process can
543 cause disk full
544 Description:
546 create a Sheepdog store
547 cluster shutdown [-a address] [-p port] [-h] [-T]
549 Options:
551 -a, --address specify the daemon address (default:
552 localhost)
553 -p, --port specify the daemon port
554 -h, --help display this help and exit
555 -T, --time show elapsed time
556 Description:
558 stop Sheepdog
559 cluster snapshot {save|list|load|show} [-a address] [-p port] [-h] [-T]
561 [-m] <tag|idx> <path> [vdi1] [vdi2] ...
562 Available subcommands:
564 save save snapshot to localpath
565 list list snapshot of localpath
566 load load snapshot from localpath
567 show show vdi list from snapshot
568 Options:
570 -a, --address specify the daemon address (default:
571 localhost)
572 -p, --port specify the daemon port
573 -h, --help display this help and exit
574 -T, --time show elapsed time
575 -m, --multithread use multi-thread for 'cluster snapshot
576 save'
577 Description:
579 snapshot/restore the cluster
580 cluster recover {force|enable|disable} [-a address] [-f] [-p port] [-h]
582 [-T]
583 Available subcommands:
585 force force recover cluster immediately
586 enable enable automatic recovery and run once
587 recover if necessary
588 disable disable automatic recovery
589 Options:
591 -a, --address specify the daemon address (default:
592 localhost)
593 -f, --force do not prompt for confirmation
594 -p, --port specify the daemon port
595 -h, --help display this help and exit
596 -T, --time show elapsed time
597 Description:
599 See 'dog cluster recover' for more information
600 cluster reweight [-a address] [-p port] [-h] [-T]
602 Options:
604 -a, --address specify the daemon address (default:
605 localhost)
606 -p, --port specify the daemon port
607 -h, --help display this help and exit
608 -T, --time show elapsed time
609 Description:
611 reweight the cluster
612 cluster check [-a address] [-p port] [-h] [-T]
614 Options:
616 -a, --address specify the daemon address (default:
617 localhost)
618 -p, --port specify the daemon port
619 -h, --help display this help and exit
620 -T, --time show elapsed time
621 Description:
623 check and repair cluster
624 cluster alter-copy [-a address] [-p port] [-h] [-T] [-c copies] [-f]
626 Options:
628 -a, --address specify the daemon address (default:
629 localhost)
630 -p, --port specify the daemon port
631 -h, --help display this help and exit
632 -T, --time show elapsed time
633 -c, --copies specify the default data redundancy
634 (number of copies)
635 -f, --force do not prompt for confirmation
636 Description:
638 set the cluster's redundancy level
639 upgrade inode-convert [-h] [-T] [-o orig-version] <path of original in‐
641 ode file> <path of new inode file>
642 Options:
644 -h, --help display this help and exit
645 -T, --time show elapsed time
646 -o, --orig-version version of converting file
647 Description:
649 upgrade inode object file
650 upgrade epoch-convert [-h] [-T] [-o orig-version] <path of original
652 epoch log file> <path of new epoch log file>
653 Options:
655 -h, --help display this help and exit
656 -T, --time show elapsed time
657 -o, --orig-version version of converting file
658 Description:
660 upgrade epoch log file
661 benchmark io [-a address] [-p port] [-r] [-h] [-T] [-f] [-w workqueue]
663 [-t total] [-n nr-threads] <vdiname>
664 Options:
666 -a, --address specify the daemon address (default:
667 localhost)
668 -p, --port specify the daemon port
669 -r, --raw raw output mode: omit headers, sepa‐
670 rate fields with
671 single spaces and print all sizes in
672 decimal bytes
673 -h, --help display this help and exit
674 -T, --time show elapsed time
675 -f, --force do not prompt for confirmation
676 -w, --workqueue specify workqueue type
677 -t, --total a number of total operation (e.g. I/O
678 request)
679 -n, --nr-threads a number of worker threads (only used
680 for fixed workqueue)
681 Description:
683 benchmark I/O performance
684
687 Sheepdog requires QEMU 0.13.z or later and Corosync 1.y.z or 2.y.z.
688
691 none
692
695 sheep(8), qemu(1), sheepfs(8), corosync_overview(8)
696
699 This software is developed by the Sheepdog community which may be
700 reached via mailing list at <sheepdog@lists.wpkg.org>.
701 2023-07-22 SHEEPDOG(8)