1 '\" te
   2 .\" Copyright 2013 Nexenta Systems, Inc. All rights reserved.
   3 .TH BEADM 1M "Jul 25, 2013"
   4 .SH NAME
   5 beadm \- utility for managing zfs boot environments
   6 .SH SYNOPSIS
   7 .LP
   8 .nf
   9 \fBbeadm\fR \fBcreate\fR [\fB-a\fR] [\fB-d\fR \fIdescription\fR]
  10      [\fB-e\fR \fInon-activeBeName\fR | \fIbeName@snapshot\fR]
  11      [\fB-o\fR \fIproperty=value\fR] ... [\fB-p\fR \fIzpool\fR]
  12      [\fB-v\fR] \fIbeName\fR
  13 .fi
  14 
  15 .LP
  16 .nf
  17 \fBbeadm\fR \fBcreate\fR [\fB-v\fR] \fIbeName@snapshot\fR
  18 .fi
  19 
  20 .LP
  21 .nf
  22 \fBbeadm\fR \fBdestroy\fR [\fB-fFsv\fR] \fIbeName\fR | \fIbeName@snapshot\fR
  23 .fi
  24 
  25 .LP
  26 .nf
  27 \fBbeadm\fR \fBlist\fR [\fB-a\fR | \fB-ds\fR] [\fB-H\fR] [\fB-v\fR] [\fIbeName\fR]
  28 .fi
  29 
  30 .LP
  31 .nf
  32 \fBbeadm\fR \fBmount\fR [\fB-v\fR] \fIbeName\fR \fImountpoint\fR
  33 .fi
  34 
  35 .LP
  36 .nf
  37 \fBbeadm\fR \fBunmount\fR [\fB-fv\fR] \fIbeName\fR | \fImountpoint\fR
  38 .fi
  39 
  40 .LP
  41 .nf
  42 \fBbeadm\fR \fBrename\fR [\fB-v\fR] \fIbeName\fR \fInewBeName\fR
  43 .fi
  44 
  45 .LP
  46 .nf
  47 \fBbeadm\fR \fBactivate\fR [\fB-v\fR] \fIbeName\fR
  48 .fi
  49 
  50 .LP
  51 .nf
  52 \fBbeadm\fR \fBrollback\fR [\fB-v\fR] \fIbeName\fR \fIsnapshot\fR

 390 .ad
 391 .sp .6
 392 .RS 4n
 393 Do not list header information.  Each field in the list information is
 394 separated by a semicolon.
 395 .RE
 396 .sp
 397 .ne 2
 398 .na
 399 \fB-v\fR
 400 .ad
 401 .sp .6
 402 .RS 4n
 403 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
 404 .RE
 405 .RE
 406 
 407 .sp
 408 .ne 2
 409 .na
 410 \fBbeadm\fR \fBmount\fR [\fB-v\fR] \fIbeName\fR \fImountpoint\fR
 411 .ad
 412 .sp .6
 413 .RS 4n
 414 Mounts a boot environment named beName at mountpoint.  mountpoint must be an
 415 already existing empty directory.
 416 .sp
 417 .ne 2









 418 .na
 419 \fB-v\fR
 420 .ad
 421 .sp .6
 422 .RS 4n
 423 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
 424 .RE
 425 .RE
 426 
 427 .sp
 428 .ne 2
 429 .na
 430 \fBbeadm\fR \fBunmount\fR [\fB-fv\fR] \fIbeName\fR | \fImountpoint\fR
 431 .ad
 432 .sp .6
 433 .RS 4n
 434 Unmounts the boot environment named beName. The command can also be given a path to a
 435 beName mount point on the system.
 436 .sp
 437 .ne 2

   1 '\" te
   2 .\" Copyright 2013 Nexenta Systems, Inc. All rights reserved.
   3 .TH BEADM 1M "Nov 11, 2013"
   4 .SH NAME
   5 beadm \- utility for managing zfs boot environments
   6 .SH SYNOPSIS
   7 .LP
   8 .nf
   9 \fBbeadm\fR \fBcreate\fR [\fB-a\fR] [\fB-d\fR \fIdescription\fR]
  10      [\fB-e\fR \fInon-activeBeName\fR | \fIbeName@snapshot\fR]
  11      [\fB-o\fR \fIproperty=value\fR] ... [\fB-p\fR \fIzpool\fR]
  12      [\fB-v\fR] \fIbeName\fR
  13 .fi
  14 
  15 .LP
  16 .nf
  17 \fBbeadm\fR \fBcreate\fR [\fB-v\fR] \fIbeName@snapshot\fR
  18 .fi
  19 
  20 .LP
  21 .nf
  22 \fBbeadm\fR \fBdestroy\fR [\fB-fFsv\fR] \fIbeName\fR | \fIbeName@snapshot\fR
  23 .fi
  24 
  25 .LP
  26 .nf
  27 \fBbeadm\fR \fBlist\fR [\fB-a\fR | \fB-ds\fR] [\fB-H\fR] [\fB-v\fR] [\fIbeName\fR]
  28 .fi
  29 
  30 .LP
  31 .nf
  32 \fBbeadm\fR \fBmount\fR [\fB-s\fR \fBro\fR|\fBrw\fR] [\fB-v\fR] \fIbeName\fR \fImountpoint\fR
  33 .fi
  34 
  35 .LP
  36 .nf
  37 \fBbeadm\fR \fBunmount\fR [\fB-fv\fR] \fIbeName\fR | \fImountpoint\fR
  38 .fi
  39 
  40 .LP
  41 .nf
  42 \fBbeadm\fR \fBrename\fR [\fB-v\fR] \fIbeName\fR \fInewBeName\fR
  43 .fi
  44 
  45 .LP
  46 .nf
  47 \fBbeadm\fR \fBactivate\fR [\fB-v\fR] \fIbeName\fR
  48 .fi
  49 
  50 .LP
  51 .nf
  52 \fBbeadm\fR \fBrollback\fR [\fB-v\fR] \fIbeName\fR \fIsnapshot\fR

 390 .ad
 391 .sp .6
 392 .RS 4n
 393 Do not list header information.  Each field in the list information is
 394 separated by a semicolon.
 395 .RE
 396 .sp
 397 .ne 2
 398 .na
 399 \fB-v\fR
 400 .ad
 401 .sp .6
 402 .RS 4n
 403 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
 404 .RE
 405 .RE
 406 
 407 .sp
 408 .ne 2
 409 .na
 410 \fBbeadm\fR \fBmount\fR [\fB-s\fR \fBro\fR|\fBrw\fR] [\fB-v\fR] \fIbeName\fR \fImountpoint\fR
 411 .ad
 412 .sp .6
 413 .RS 4n
 414 Mounts a boot environment named beName at mountpoint.  mountpoint must be an
 415 already existing empty directory.
 416 .sp
 417 .ne 2
 418 .na
 419 \fB-s\fR \fBro\fR|\fBrw\fR
 420 .ad
 421 .sp .6
 422 .RS 4n
 423 Mount the shared filesystems of the BE in read-only or read-write mode.
 424 .RE
 425 .sp
 426 .ne 2
 427 .na
 428 \fB-v\fR
 429 .ad
 430 .sp .6
 431 .RS 4n
 432 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
 433 .RE
 434 .RE
 435 
 436 .sp
 437 .ne 2
 438 .na
 439 \fBbeadm\fR \fBunmount\fR [\fB-fv\fR] \fIbeName\fR | \fImountpoint\fR
 440 .ad
 441 .sp .6
 442 .RS 4n
 443 Unmounts the boot environment named beName. The command can also be given a path to a
 444 beName mount point on the system.
 445 .sp
 446 .ne 2