1 '\" te
2 .\" Copyright 2013 Nexenta Systems, Inc. All rights reserved.
3 .\" Copyright 2016 Toomas Soome <tsoome@me.com>
4 .TH BEADM 1M "Feb 21, 2016"
5 .SH NAME
6 beadm \- utility for managing zfs boot environments
7 .SH SYNOPSIS
8 .LP
9 .nf
10 \fBbeadm\fR \fBcreate\fR [\fB-a\fR] [\fB-d\fR \fIdescription\fR]
11 [\fB-e\fR \fInon-activeBeName\fR | \fIbeName@snapshot\fR]
12 [\fB-o\fR \fIproperty=value\fR] ... [\fB-p\fR \fIzpool\fR]
13 [\fB-v\fR] \fIbeName\fR
14 .fi
15
16 .LP
17 .nf
18 \fBbeadm\fR \fBcreate\fR [\fB-v\fR] \fIbeName@snapshot\fR
19 .fi
20
21 .LP
22 .nf
23 \fBbeadm\fR \fBdestroy\fR [\fB-fFsv\fR] \fIbeName\fR | \fIbeName@snapshot\fR
24 .fi
25
26 .LP
27 .nf
28 \fBbeadm\fR \fBlist\fR [\fB-a\fR | \fB-ds\fR] [\fB-H\fR]
540 .sp
541 .ne 2
542 .na
543 \fBbeadm\fR \fBactivate\fR [\fB-v\fR] \fIbeName\fR
544 .ad
545 .sp .6
546 .RS 4n
547 Makes beName the active BE on next reboot.
548 .sp
549 .ne 2
550 .na
551 \fB-v\fR
552 .ad
553 .sp .6
554 .RS 4n
555 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
556 .RE
557 .RE
558
559 .SH ALTERNATE BE LOCATION
560 .LP
561 The alternate BE location outside rpool/ROOT can be configured
562 by modifying the BENAME_STARTS_WITH parameter in /etc/default/be.
563 For example: BENAME_STARTS_WITH=rootfs
564
565 .SH EXAMPLES
566 .LP
567 \fBExample 1\fR: Create a new BE named BE1, by cloning the current live BE.
568 .sp
569 .in +2
570 .nf
571 \fB# beadm create BE1\fR
572 .fi
573 .in -2
574 .sp
575
576 .LP
577 \fBExample 2\fR: Create a new BE named BE2, by cloning the existing inactive
578 BE
579 named BE1.
580 .sp
581 .in +2
582 .nf
583 \fB# beadm create -e BE1 BE2\fR
584 .fi
585 .in -2
586 .sp
781 .sp
782
783 .LP
784 \fBExample 18\fR: List machine parsable information about all boot
785 environments.
786
787 .sp
788 .in +2
789 .nf
790 \fB# beadm list -H\fR
791
792 BE2;;;;55296;static;1211397974
793 BE3;;;;339968;static;1219771706
794 BE4;;;;16541696;static;1220664051
795 BE5;215b8387-4968-627c-d2d0-f4a011414bab;NR;/;7786206208;static;1221004384
796 .fi
797 .in -2
798 .sp
799
800 .SH EXIT STATUS
801 .LP
802 The following exit values are returned:
803 .sp
804 .ne 2
805 .na
806 \fB0\fR
807 .ad
808 .sp .6
809 .RS 4n
810 Successful completion
811 .RE
812
813 .sp
814 .ne 2
815 .na
816 \fB>0\fR
817 .ad
818 .sp .6
819 .RS 4n
820 Failure
821 .RE
822
823
824 .SH FILES
825 .LP
826 .sp
827 .ne 2
828 .na
829 \fB/var/log/beadm/<beName>/create.log.<yyyymmdd_hhmmss>\fR
830 .ad
831 .sp .6
832 .RS 4n
833 Log used for capturing beadm create output
834 .sp
835 .nf
836 \fIyyyymmdd_hhmmss\fR - 20071130_140558
837 \fIyy\fR - year; 2007
838 \fImm\fR - month; 11
839 \fIdd\fR - day; 30
840 \fIhh\fR - hour; 14
841 \fImm\fR - minute; 05
842 \fIss\fR - second; 58
843 .fi
844 .in -2
845 .sp
846 .RE
847 .sp
848 .LP
849 .sp
850 .ne 2
851 .na
852 \fB/etc/default/be\fR
853 .ad
854 .sp .6
855 .RS 4n
856 Contains default value for BENAME_STARTS_WITH parameter
857 .sp
858 .RE
859
860 .SH ATTRIBUTES
861 .LP
862 See \fBattributes\fR(5) for descriptions of the following attributes:
863 .sp
864
865 .sp
866 .TS
867 box;
868 c | c
869 l | l .
870 ATTRIBUTE TYPE ATTRIBUTE VALUE
871 _
872 Interface Stability Uncommitted
873 .TE
874
875
876 .SH SEE ALSO
877 .LP
878 .BR zfs (1M)
|
1 '\" te
2 .\" Copyright 2013 Nexenta Systems, Inc. All rights reserved.
3 .\" Copyright 2016 Toomas Soome <tsoome@me.com>
4 .TH BEADM 1M "Feb 21, 2016"
5 .SH NAME
6 beadm \- utility for managing zfs boot environments
7 .SH SYNOPSIS
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]
539 .sp
540 .ne 2
541 .na
542 \fBbeadm\fR \fBactivate\fR [\fB-v\fR] \fIbeName\fR
543 .ad
544 .sp .6
545 .RS 4n
546 Makes beName the active BE on next reboot.
547 .sp
548 .ne 2
549 .na
550 \fB-v\fR
551 .ad
552 .sp .6
553 .RS 4n
554 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
555 .RE
556 .RE
557
558 .SH ALTERNATE BE LOCATION
559 The alternate BE location outside rpool/ROOT can be configured
560 by modifying the BENAME_STARTS_WITH parameter in /etc/default/be.
561 For example: BENAME_STARTS_WITH=rootfs
562
563 .SH EXAMPLES
564 \fBExample 1\fR: Create a new BE named BE1, by cloning the current live BE.
565 .sp
566 .in +2
567 .nf
568 \fB# beadm create BE1\fR
569 .fi
570 .in -2
571 .sp
572
573 .LP
574 \fBExample 2\fR: Create a new BE named BE2, by cloning the existing inactive
575 BE
576 named BE1.
577 .sp
578 .in +2
579 .nf
580 \fB# beadm create -e BE1 BE2\fR
581 .fi
582 .in -2
583 .sp
778 .sp
779
780 .LP
781 \fBExample 18\fR: List machine parsable information about all boot
782 environments.
783
784 .sp
785 .in +2
786 .nf
787 \fB# beadm list -H\fR
788
789 BE2;;;;55296;static;1211397974
790 BE3;;;;339968;static;1219771706
791 BE4;;;;16541696;static;1220664051
792 BE5;215b8387-4968-627c-d2d0-f4a011414bab;NR;/;7786206208;static;1221004384
793 .fi
794 .in -2
795 .sp
796
797 .SH EXIT STATUS
798 The following exit values are returned:
799 .sp
800 .ne 2
801 .na
802 \fB0\fR
803 .ad
804 .sp .6
805 .RS 4n
806 Successful completion
807 .RE
808
809 .sp
810 .ne 2
811 .na
812 \fB>0\fR
813 .ad
814 .sp .6
815 .RS 4n
816 Failure
817 .RE
818
819
820 .SH FILES
821 .ne 2
822 .na
823 \fB/var/log/beadm/<beName>/create.log.<yyyymmdd_hhmmss>\fR
824 .ad
825 .sp .6
826 .RS 4n
827 Log used for capturing beadm create output
828 .sp
829 .nf
830 \fIyyyymmdd_hhmmss\fR - 20071130_140558
831 \fIyy\fR - year; 2007
832 \fImm\fR - month; 11
833 \fIdd\fR - day; 30
834 \fIhh\fR - hour; 14
835 \fImm\fR - minute; 05
836 \fIss\fR - second; 58
837 .fi
838 .in -2
839 .sp
840 .RE
841 .sp
842 .LP
843 .ne 2
844 .na
845 \fB/etc/default/be\fR
846 .ad
847 .sp .6
848 .RS 4n
849 Contains default value for BENAME_STARTS_WITH parameter
850 .sp
851 .RE
852
853 .SH ATTRIBUTES
854 See \fBattributes\fR(5) for descriptions of the following attributes:
855 .sp
856
857 .sp
858 .TS
859 box;
860 c | c
861 l | l .
862 ATTRIBUTE TYPE ATTRIBUTE VALUE
863 _
864 Interface Stability Uncommitted
865 .TE
866
867
868 .SH SEE ALSO
869 .BR zfs (1M)
|