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
222 \fB-o\fR \fIproperty=value\fR
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.
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
351 .ne 2
352 .na
353 \fB-a\fR
354 .ad
355 .sp .6
356 .RS 4n
357 Lists all available information about the boot environment. This includes
358 subordinate file systems and snapshots.
359 .RE
360 .sp
361 .ne 2
362 .na
363 \fB-d\fR
364 .ad
365 .sp .6
366 .RS 4n
367 Lists information about all subordinate file systems belonging to the boot
368 environment.
369 .RE
|
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
222 \fB-o\fR \fIproperty=value\fR
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 This option is not supported in non-global zone.
243 .RE
244 .sp
245 .ne 2
246 .na
247 \fB-v\fR
248 .ad
249 .sp .6
250 .RS 4n
251 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
252 .RE
253 .RE
254
255 .sp
256 .ne 2
257 .na
258 \fBbeadm\fR \fBcreate\fR [\fB-v\fR] \fIbeName@snapshot\fR
259 .ad
260 .sp .6
261 .RS 4n
262 Creates a snapshot of the existing BE named beName.
322 .sp .6
323 .RS 4n
324 Verbose mode. Displays verbose error messages from \fBbeadm\fR.
325 .RE
326 .RE
327
328 .sp
329 .ne 2
330 .na
331 \fBbeadm\fR \fBlist\fR [\fB-a\fR | \fB-ds\fR] [\fB-H\fR] [\fB-v\fR] [\fIbeName\fR]
332 .ad
333 .sp .6
334 .RS 4n
335 Lists information about the existing boot environment named \fIbeName\fR, or
336 lists
337 information for all boot environments if \fIbeName\fR is not provided.
338 The 'Active'
339 field indicates whether the boot environment is active now,
340 represented
341 by 'N'; active on reboot, represented by 'R'; or both, represented
342 by 'NR'. In non-global zone the 'Active' field also indicates whether the
343 boot environment has a non-active parent BE, represented by 'x'; is active
344 on boot in a non-active parent BE, represented by 'b'. Activate, rollback
345 and snapshot operations for boot environments from non-active global parent
346 BE aren't supported, destroy is allowed if these boot environments aren't
347 active on boot.
348 .sp
349 Each line in the machine parasable output has the boot environment name as the
350 first field. The 'Space' field is displayed in bytes and the 'Created' field
351 is displayed in UTC format. The \fB-H\fR option used with no other options
352 gives
353 the boot environment's uuid in the second field. This field will be
354 blank if
355 the boot environment does not have a uuid. See the EXAMPLES section.
356 In non-global zones, this field shows the uuid of the parent BE.
357 .sp
358 .ne 2
359 .na
360 \fB-a\fR
361 .ad
362 .sp .6
363 .RS 4n
364 Lists all available information about the boot environment. This includes
365 subordinate file systems and snapshots.
366 .RE
367 .sp
368 .ne 2
369 .na
370 \fB-d\fR
371 .ad
372 .sp .6
373 .RS 4n
374 Lists information about all subordinate file systems belonging to the boot
375 environment.
376 .RE
|