1 '\" te
2 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
3 .TH BEADM 1M "Feb 26, 2011"
4 .SH NAME
5 beadm \- utility for managing zfs boot environments
6 .SH SYNOPSIS
7 .LP
8 .nf
9 \fBbeadm\fR create [\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\FI] \fIbeName\fR
12 .fi
13
14 .LP
15 .nf
16 \fBbeadm\fR \fBcreate\fR \fIbeName@snapshot\fR
17 .fi
18
19 .LP
20 .nf
21 \fBbeadm\fR \fBdestroy\fR [\fB-fFs\fR] \fIbeName\fR | \fIbeName@snapshot\fR
22 .fi
23
24 .LP
25 .nf
26 \fBbeadm\fR \fBlist\fR [\fB-a\fR | \fB-ds\fR] [\fB-H\fR] [\fIbeName\fR]
27 .fi
28
29 .LP
30 .nf
31 \fBbeadm\fR \fBmount\fR \fIbeName\fR \fImountpoint\fR
32 .fi
33
34 .LP
35 .nf
36 \fBbeadm\fR \fBunmount\fR [\fB-f\fR] \fIbeName\fR | \fImountpoint\fR
37 .fi
38
39 .LP
40 .nf
41 \fBbeadm\fR \fBrename\fR \fIbeName\fR \fInewBeName\fR
42 .fi
43
44 .LP
45 .nf
46 \fBbeadm\fR \fBactivate\fR \fIbeName\fR
47 .fi
48
49 .LP
50 .nf
51 \fBbeadm\fR \fBrollback\fR \fIbeName\fR \fIsnapshot\fR
52 .fi
53
54 .LP
55 .nf
56 \fBbeadm\fR \fBrollback\fR \fIbeName@snapshot\fR
57 .fi
58
59 .SH DESCRIPTION
60 The \fBbeadm\fR command is the user interface for managing zfs Boot
61 Environments (BEs). This utility is intended to be used by System
62 Administrators who want to manage multiple Solaris Instances on a single
63 system.
64 .sp
65 The \fBbeadm\fR command supports the following operations:
66 .RS +4
67 .TP
68 .ie t \(bu
69 .el -
70 Create a new BE, based on the active BE.
71 .RE
72 .RS +4
73 .TP
74 .ie t \(bu
75 .el -
76 Create a new BE, based on an inactive BE.
143 .RE
144
145 .SH SUBCOMMANDS
146 The \fBbeadm\fR command has the subcommands and options listed
147 below. Also see
148 EXAMPLES below.
149 .sp
150 .ne 2
151 .na
152 \fBbeadm\fR
153 .ad
154 .sp .6
155 .RS 4n
156 Displays command usage.
157 .RE
158
159 .sp
160 .ne 2
161 .na
162 \fBbeadm\fR \fBcreate\fR [\fB-a\fR] [\fB-d\fR \fIdescription\fR]
163 [\fB-e\fR \fInon-activeBeName\fR | \fIbeName@snapshot\fR]
164 [\fB-o\fR
165 \fIproperty=value\fR] ... [\fB-p\fR \fIzpool\fR] \fIbeName\fR
166
167 .ad
168 .sp .6
169 .RS 4n
170 Creates a new boot environment named \fIbeName\fR. If the \fB-e\fR option is
171 not
172 provided, the new boot environment will be created as a clone of the
173 currently
174 running boot environment. If the \fB-d\fR option is provided then the
175 description is
176 also used as the title for the BE's entry in the GRUB menu for
177 x86 systems or
178 in the boot menu for SPARC systems. If the \fB-d\fR option is
179 not provided, \fIbeName\fR
180 will be used as the title.
181 .sp
182 .ne 2
183 .na
184 \fB-a\fR
185 .ad
222 .ad
223 .sp .6
224 .RS 4n
225 Create the datasets for new BE with specific ZFS properties. Multiple
226 \fB-o\fR
227 options can be specified. See \fBzfs\fR(1M) for more information on
228 the
229 \fB-o\fR option.
230 .RE
231 .sp
232 .ne 2
233 .na
234 \fB-p\fR \fIzpool\fR
235 .ad
236 .sp .6
237 .RS 4n
238 Create the new BE in the specified zpool. If this is not provided, the
239 default
240 behavior is to create the new BE in the same pool as as the origin BE.
241 .RE
242 .RE
243
244 .sp
245 .ne 2
246 .na
247 \fBbeadm\fR \fBcreate\fR \fIbeName@snapshot\fR
248 .ad
249 .sp .6
250 .RS 4n
251 Creates a snapshot of the existing BE named beName.
252 .RE
253
254 .sp
255 .ne 2
256 .na
257 \fBbeadm\fR \fBdestroy\fR [\fB-fFs\fR] \fIbeName\fR | \fIbeName@snapshot\fR
258 .ad
259 .sp .6
260 .RS 4n
261 Destroys the boot environment named \fIbeName\fR or destroys an existing
262 snapshot of
263 the boot environment named \fIbeName@snapshot\fR. Destroying a
264 boot environment
265 will also destroy all snapshots of that boot environment. Use
266 this command
267 with caution.
268 .sp
269 .ne 2
270 .na
271 \fB-f\fR
272 .ad
273 .sp .6
274 .RS 4n
275 Forcefully unmount the boot environment if it is currently mounted.
276 .RE
277 .sp
278 .ne 2
279 .na
280 \fB-F\fR
281 .ad
282 .sp .6
283 .RS 4n
284 Force the action without prompting to verify the destruction of the boot
285 environment.
286 .RE
287 .sp
288 .ne 2
289 .na
290 \fB-s\fR
291 .ad
292 .sp .6
293 .RS 4n
294 Destroy all snapshots of the boot
295 environment.
296 .RE
297 .RE
298
299 .sp
300 .ne 2
301 .na
302 \fBbeadm\fR \fBlist\fR [\fB-a\fR | \fB-ds\fR] [\fB-H\fR] [\fIbeName\fR]
303 .ad
304 .sp .6
305 .RS 4n
306 Lists information about the existing boot environment named \fIbeName\fR, or
307 lists
308 information for all boot environments if \fIbeName\fR is not provided.
309 The 'Active'
310 field indicates whether the boot environment is active now,
311 represented
312 by 'N'; active on reboot, represented by 'R'; or both, represented
313 by 'NR'.
314 .sp
315 Each line in the machine parasable output has the boot environment name as the
316 first field. The 'Space' field is displayed in bytes and the 'Created' field
317 is displayed in UTC format. The \fB-H\fR option used with no other options
318 gives
319 the boot environment's uuid in the second field. This field will be
320 blank if
321 the boot environment does not have a uuid. See the EXAMPLES section.
322 .sp
341 .RE
342 .sp
343 .ne 2
344 .na
345 \fB-s\fR
346 .ad
347 .sp .6
348 .RS 4n
349 Lists information about the snapshots of the boot environment.
350 .RE
351 .sp
352 .ne 2
353 .na
354 \fB-H\fR
355 .ad
356 .sp .6
357 .RS 4n
358 Do not list header information. Each field in the list information is
359 separated by a semicolon.
360 .RE
361 .RE
362
363 .sp
364 .ne 2
365 .na
366 \fBbeadm\fR \fBmount\fR \fIbeName\fR \fImountpoint\fR
367 .ad
368 .sp .6
369 .RS 4n
370 Mounts a boot environment named beName at mountpoint. mountpoint must be an
371 already existing empty directory.
372 .RE
373
374 .sp
375 .ne 2
376 .na
377 \fBbeadm\fR \fBunmount\fR [\fB-f\fR] \fIbeName\fR | \fImountpoint\fR
378 .ad
379 .sp .6
380 .RS 4n
381 Unmounts the boot environment named beName. The command can also be given a path to a
382 beName mount point on the system.
383 .sp
384 .ne 2
385 .na
386 \fB-f\fR
387 .ad
388 .sp .6
389 .RS 4n
390 Forcefully unmount the boot environment even if its currently busy.
391 .RE
392 .RE
393
394 .sp
395 .ne 2
396 .na
397 \fBbeadm\fR \fBrename\fR \fIbeName\fR \fInewBeName\fR
398 .ad
399 .sp .6
400 .RS 4n
401 Renames the boot environment named \fIbeName\fR to \fInewBeName\fR.
402 .RE
403
404 .sp
405 .ne 2
406 .na
407 \fBbeadm\fR \fBrollback\fR \fIbeName\fR \fIsnapshot\fR | \fIbeName@snapshot\fR
408 .ad
409 .sp .6
410 .RS 4n
411 Roll back the boot environment named \fIbeName\fR to existing snapshot
412 of the boot environment named \fIbeName@snapshot\fR.
413 .RE
414
415 .sp
416 .ne 2
417 .na
418 \fBbeadm\fR \fBactivate\fR \fIbeName\fR
419 .ad
420 .sp .6
421 .RS 4n
422 Makes beName the active BE on next reboot.
423 .RE
424
425 .SH ALTERNATE BE LOCATION
426 .LP
427 The alternate BE location outside rpool/ROOT can be configured
428 by modifying the BENAME_STARTS_WITH parameter in /etc/default/be.
429 For example: BENAME_STARTS_WITH=rootfs
430
431 .SH EXAMPLES
432 .LP
433 \fBExample 1\fR: Create a new BE named BE1, by cloning the current live BE.
434 .sp
435 .in +2
436 .nf
437 \fB# beadm create BE1\fR
438 .fi
439 .in -2
440 .sp
441
442 .LP
443 \fBExample 2\fR: Create a new BE named BE2, by cloning the existing inactive
|
1 '\" te
2 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
3 .TH BEADM 1M "Feb 26, 2011"
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
53 .fi
54
55 .LP
56 .nf
57 \fBbeadm\fR \fBrollback\fR [\fB-v\fR] \fIbeName@snapshot\fR
58 .fi
59
60 .SH DESCRIPTION
61 The \fBbeadm\fR command is the user interface for managing zfs Boot
62 Environments (BEs). This utility is intended to be used by System
63 Administrators who want to manage multiple Solaris Instances on a single
64 system.
65 .sp
66 The \fBbeadm\fR command supports the following operations:
67 .RS +4
68 .TP
69 .ie t \(bu
70 .el -
71 Create a new BE, based on the active BE.
72 .RE
73 .RS +4
74 .TP
75 .ie t \(bu
76 .el -
77 Create a new BE, based on an inactive BE.
144 .RE
145
146 .SH SUBCOMMANDS
147 The \fBbeadm\fR command has the subcommands and options listed
148 below. Also see
149 EXAMPLES below.
150 .sp
151 .ne 2
152 .na
153 \fBbeadm\fR
154 .ad
155 .sp .6
156 .RS 4n
157 Displays command usage.
158 .RE
159
160 .sp
161 .ne 2
162 .na
163 \fBbeadm\fR \fBcreate\fR [\fB-a\fR] [\fB-d\fR \fIdescription\fR]
164 [\fB-e\fR \fInon-activeBeName\fR | \fIbeName@snapshot\fR]
165 [\fB-o\fR \fIproperty=value\fR] ... [\fB-p\fR \fIzpool\fR]
166 [\fB-v\fR] \fIbeName\fR
167
168 .ad
169 .sp .6
170 .RS 4n
171 Creates a new boot environment named \fIbeName\fR. If the \fB-e\fR option is
172 not
173 provided, the new boot environment will be created as a clone of the
174 currently
175 running boot environment. If the \fB-d\fR option is provided then the
176 description is
177 also used as the title for the BE's entry in the GRUB menu for
178 x86 systems or
179 in the boot menu for SPARC systems. If the \fB-d\fR option is
180 not provided, \fIbeName\fR
181 will be used as the title.
182 .sp
183 .ne 2
184 .na
185 \fB-a\fR
186 .ad
223 .ad
224 .sp .6
225 .RS 4n
226 Create the datasets for new BE with specific ZFS properties. Multiple
227 \fB-o\fR
228 options can be specified. See \fBzfs\fR(1M) for more information on
229 the
230 \fB-o\fR option.
231 .RE
232 .sp
233 .ne 2
234 .na
235 \fB-p\fR \fIzpool\fR
236 .ad
237 .sp .6
238 .RS 4n
239 Create the new BE in the specified zpool. If this is not provided, the
240 default
241 behavior is to create the new BE in the same pool as as the origin BE.
242 .RE
243 .sp
244 .ne 2
245 .na
246 \fB-v\fR
247 .ad
248 .sp .6
249 .RS 4n
250 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
251 .RE
252 .RE
253
254 .sp
255 .ne 2
256 .na
257 \fBbeadm\fR \fBcreate\fR [\fB-v\fR] \fIbeName@snapshot\fR
258 .ad
259 .sp .6
260 .RS 4n
261 Creates a snapshot of the existing BE named beName.
262 .sp
263 .ne 2
264 .na
265 \fB-v\fR
266 .ad
267 .sp .6
268 .RS 4n
269 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
270 .RE
271 .RE
272
273 .sp
274 .ne 2
275 .na
276 \fBbeadm\fR \fBdestroy\fR [\fB-fFsv\fR] \fIbeName\fR | \fIbeName@snapshot\fR
277 .ad
278 .sp .6
279 .RS 4n
280 Destroys the boot environment named \fIbeName\fR or destroys an existing
281 snapshot of
282 the boot environment named \fIbeName@snapshot\fR. Destroying a
283 boot environment
284 will also destroy all snapshots of that boot environment. Use
285 this command
286 with caution.
287 .sp
288 .ne 2
289 .na
290 \fB-f\fR
291 .ad
292 .sp .6
293 .RS 4n
294 Forcefully unmount the boot environment if it is currently mounted.
295 .RE
296 .sp
297 .ne 2
298 .na
299 \fB-F\fR
300 .ad
301 .sp .6
302 .RS 4n
303 Force the action without prompting to verify the destruction of the boot
304 environment.
305 .RE
306 .sp
307 .ne 2
308 .na
309 \fB-s\fR
310 .ad
311 .sp .6
312 .RS 4n
313 Destroy all snapshots of the boot
314 environment.
315 .RE
316 .sp
317 .ne 2
318 .na
319 \fB-v\fR
320 .ad
321 .sp .6
322 .RS 4n
323 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
324 .RE
325 .RE
326
327 .sp
328 .ne 2
329 .na
330 \fBbeadm\fR \fBlist\fR [\fB-a\fR | \fB-ds\fR] [\fB-H\fR] [\fB-v\fR] [\fIbeName\fR]
331 .ad
332 .sp .6
333 .RS 4n
334 Lists information about the existing boot environment named \fIbeName\fR, or
335 lists
336 information for all boot environments if \fIbeName\fR is not provided.
337 The 'Active'
338 field indicates whether the boot environment is active now,
339 represented
340 by 'N'; active on reboot, represented by 'R'; or both, represented
341 by 'NR'.
342 .sp
343 Each line in the machine parasable output has the boot environment name as the
344 first field. The 'Space' field is displayed in bytes and the 'Created' field
345 is displayed in UTC format. The \fB-H\fR option used with no other options
346 gives
347 the boot environment's uuid in the second field. This field will be
348 blank if
349 the boot environment does not have a uuid. See the EXAMPLES section.
350 .sp
369 .RE
370 .sp
371 .ne 2
372 .na
373 \fB-s\fR
374 .ad
375 .sp .6
376 .RS 4n
377 Lists information about the snapshots of the boot environment.
378 .RE
379 .sp
380 .ne 2
381 .na
382 \fB-H\fR
383 .ad
384 .sp .6
385 .RS 4n
386 Do not list header information. Each field in the list information is
387 separated by a semicolon.
388 .RE
389 .sp
390 .ne 2
391 .na
392 \fB-v\fR
393 .ad
394 .sp .6
395 .RS 4n
396 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
397 .RE
398 .RE
399
400 .sp
401 .ne 2
402 .na
403 \fBbeadm\fR \fBmount\fR [\fB-v\fR] \fIbeName\fR \fImountpoint\fR
404 .ad
405 .sp .6
406 .RS 4n
407 Mounts a boot environment named beName at mountpoint. mountpoint must be an
408 already existing empty directory.
409 .sp
410 .ne 2
411 .na
412 \fB-v\fR
413 .ad
414 .sp .6
415 .RS 4n
416 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
417 .RE
418 .RE
419
420 .sp
421 .ne 2
422 .na
423 \fBbeadm\fR \fBunmount\fR [\fB-fv\fR] \fIbeName\fR | \fImountpoint\fR
424 .ad
425 .sp .6
426 .RS 4n
427 Unmounts the boot environment named beName. The command can also be given a path to a
428 beName mount point on the system.
429 .sp
430 .ne 2
431 .na
432 \fB-f\fR
433 .ad
434 .sp .6
435 .RS 4n
436 Forcefully unmount the boot environment even if its currently busy.
437 .RE
438 .sp
439 .ne 2
440 .na
441 \fB-v\fR
442 .ad
443 .sp .6
444 .RS 4n
445 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
446 .RE
447 .RE
448
449 .sp
450 .ne 2
451 .na
452 \fBbeadm\fR \fBrename\fR [\fB-v\fR] \fIbeName\fR \fInewBeName\fR
453 .ad
454 .sp .6
455 .RS 4n
456 Renames the boot environment named \fIbeName\fR to \fInewBeName\fR.
457 .sp
458 .ne 2
459 .na
460 \fB-v\fR
461 .ad
462 .sp .6
463 .RS 4n
464 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
465 .RE
466 .RE
467
468 .sp
469 .ne 2
470 .na
471 \fBbeadm\fR \fBrollback\fR [\fB-v\fR] \fIbeName\fR \fIsnapshot\fR | \fIbeName@snapshot\fR
472 .ad
473 .sp .6
474 .RS 4n
475 Roll back the boot environment named \fIbeName\fR to existing snapshot
476 of the boot environment named \fIbeName@snapshot\fR.
477 .sp
478 .ne 2
479 .na
480 \fB-v\fR
481 .ad
482 .sp .6
483 .RS 4n
484 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
485 .RE
486 .RE
487
488 .sp
489 .ne 2
490 .na
491 \fBbeadm\fR \fBactivate\fR [\fB-v\fR] \fIbeName\fR
492 .ad
493 .sp .6
494 .RS 4n
495 Makes beName the active BE on next reboot.
496 .sp
497 .ne 2
498 .na
499 \fB-v\fR
500 .ad
501 .sp .6
502 .RS 4n
503 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
504 .RE
505 .RE
506
507 .SH ALTERNATE BE LOCATION
508 .LP
509 The alternate BE location outside rpool/ROOT can be configured
510 by modifying the BENAME_STARTS_WITH parameter in /etc/default/be.
511 For example: BENAME_STARTS_WITH=rootfs
512
513 .SH EXAMPLES
514 .LP
515 \fBExample 1\fR: Create a new BE named BE1, by cloning the current live BE.
516 .sp
517 .in +2
518 .nf
519 \fB# beadm create BE1\fR
520 .fi
521 .in -2
522 .sp
523
524 .LP
525 \fBExample 2\fR: Create a new BE named BE2, by cloning the existing inactive
|