System Administration Commands beadm(1M)
NAME
beadm - manage ZFS boot environments
SYNOPSIS
beadm create [-a] [-d description]
[-e non-activeBeName | beName@snapshot]
[-o property=value] ... [-p zpool] beName
beadm create beName@snapshot
beadm destroy [-fF] beName | beName@snapshot
beadm list [-a | -ds] [-H] [beName]
beadm mount beName mountpoint
beadm unmount [-f] beName
beadm rename beName newBeName
beadm activate beName
DESCRIPTION
The beadm command is the user interface for managing ZFS
Boot Environments (BEs). This utility is intended to be used by system administrators who want to manage multiple Oracle Solaris instances on a single system.Using beadm, you can do the following:
o Create a new BE, based on the active BE. o Create a new BE, based on an inactive BE. o Create a snapshot of an existing BE. o Create a new BE, based on an existing snapshot. o Create a new BE, and copy it to a different zpool. o Activate an existing, inactive BE. o Mount a BE.SunOS 5.11 Last change: 21 Jul 2010 1
System Administration Commands beadm(1M)
o Unmount a BE. o Destroy a BE. o Destroy a snapshot of a BE. o Rename an existing, inactive BE. o Display information about your snapshots and datasets.SUB-COMMANDS
The beadm command has the subcommands and options listed
below. Usage of many of these subcommands and options isillustrated in EXAMPLES, below.
beadm (no arguments)
Displays command usage.beadm create [-a] [-d description] [-e non-activeBeName |
beName@snapshot] [-o property=value] ... [-p zpool] beName
Creates a new boot environment named beName. If the -e
option is not provided, the new boot environment will be created as a clone of the currently running bootenvironment. If the -d option is provided, then the
description is also used as the title for the BE's entry in the GRUB menu for x86 systems or in the boot menu forSPARC systems. If the -d option is not provided, beName
will be used as the title.-a
Activate the newly created BE upon creation. The default is to not activate the newly created BE.-d description
Create a new BE with a description associated with it.-e non-activeBeName
Create a new BE from an existing inactive BE.-e beName@snapshot
SunOS 5.11 Last change: 21 Jul 2010 2
System Administration Commands beadm(1M)
Create a new BE from an existing snapshot of the BE named beName.-o property=value
Create the datasets for a new BE with specific ZFSproperties. Multiple -o options can be specified.
See zfs(1M) for more information on the -o option.
-p zpool
Create the new BE in the specified zpool. If this is not provided, the default behavior is to create the new BE in the same pool as the origin BE.beadm create beName@snapshot
Creates a snapshot of the existing BE named beName.beadm destroy [-fF] beName | beName@snapshot
Destroys the boot environment named beName or destroys an existing snapshot of the boot environment named beName@snapshot. Destroying a boot environment will also destroy all snapshots of that boot environment. Use this command with caution.-f
Forcefully unmount the boot environment if it is currently mounted.-F
Force the action without prompting to verify the destruction of the boot environment.beadm list [-a | -ds] [-H] [beName]
Lists information about the existing boot environmentnamed beName, or lists information for all boot environ-
ments if beName is not provided. The Active field indi-
cates whether the boot environment is active now, represented by N; active on reboot, represented by R; orSunOS 5.11 Last change: 21 Jul 2010 3
System Administration Commands beadm(1M)
both, represented by NR.Each line in the machine-parsable output has the boot
environment name as the first field. The Space field is displayed in bytes and the Created field is displayed inUTC format. The -H option used with no other options
gives the boot environment's UUID in the second field. This field will be blank if the boot environment doesnot have a UUID. See the EXAMPLES section.
-a
Lists all available information about the boot environment. This includes subordinate file systems and snapshots.-d
Lists information about all subordinate file systems belonging to the boot environment.-s
Lists information about the snapshots of the boot environment.-H
Do not list header information. Each field in the list information is separated by a semicolon.beadm mount beName mountpoint
Mounts a boot environment named beName at mountpoint. mountpoint must be an already existing empty directory.beadm unmount [-f] beName
Unmounts a boot environment named beName.-f
Forcefully unmount the boot environment even if it is currently busy.SunOS 5.11 Last change: 21 Jul 2010 4
System Administration Commands beadm(1M)
beadm rename beName newBeName
Renames the boot environment named beName to newBeName.beadm activate beName
Makes beName the active BE on next reboot.EXAMPLES
Example 1 Creating a New BE Using Active BE The following command creates a new BE, BE1, by cloning the current BE.# beadm create BE1
Example 2 Creating a New BE Using Inactive BE The following command creates a new BE, BE2, by cloning the existing inactive BE named BE1.# beadm beadm create -e BE1 BE2
Example 3 Creating a Snapshot of Existing BE The following command creates a snapshot named now of the existing BE named BE1.# beadm create BE1@now
Example 4 Cloning a Snapshot to Create a New BE The following command creates a new BE named BE3, by cloning an existing snapshot of BE1.# beadm create -e BE1@now BE3
SunOS 5.11 Last change: 21 Jul 2010 5
System Administration Commands beadm(1M)
Example 5 Creating a New BE in Specified zpool The following command creates a new BE named BE4, based on the currently running BE. The command creates the new BE in the zpool rpool2.# beadm create -p rpool2 BE4
Example 6 Creating a New BE in Specified zpool with Compres-
sion Enabled The following command creates a new BE named BE5, based on the currently running BE. The command creates the new BE in the zpool rpool2 and creates its datasets with compression turned on.# beadm create -p rpool2 -o compression=on BE5
Example 7 Creating a New BE and Providing a Description The following command creates a new BE named BE6, based on the currently running BE, and provides a description for it.# beadm create -d "BE6 used as test environment" BE6
Example 8 Activating a BE The following command activates an existing, inactive BE named BE3.# beadm activate BE3
Example 9 Mounting a BESunOS 5.11 Last change: 21 Jul 2010 6
System Administration Commands beadm(1M)
The following command mounts the BE named BE3 at /mnt.# beadm mount BE3 /mnt
Example 10 Unmounting a BE The following command unmounts the BE named BE3.# beadm unmount BE3
Example 11 Destroying a BEThe following command destroys the BE named BE3 without ask-
ing for confirmation.# beadm destroy -F BE3
Example 12 Destroying a Snapshot The following command destroys the snapshot named now of BE1.# beadm destroy BE1@now
Example 13 Renaming a BE The following command renames the existing, inactive BE named BE1 to BE3.# beadm rename BE1 BE3
Example 14 Listing All BEsSunOS 5.11 Last change: 21 Jul 2010 7
System Administration Commands beadm(1M)
The following command lists all existing BEs.# beadm list
BE Active Mountpoint Space Policy Created-- ------ ---------- ----- ------ -------
BE2 - - 72.0K static 2008-05-21 12:26
BE3 - - 332.0K static 2008-08-26 10:28
BE4 - - 15.78M static 2008-09-05 18:20
BE5 NR / 7.25G static 2008-09-09 16:53
Example 15 Listing All BEs with Dataset and Snapshot Info The following command lists all existing BEs and list all dataset and snapshot information about those boot environments.# beadm list -d -s
BE/Dataset/Snapshot Active Mountpoint Space Policy Created
------------------- ------ ---------- ----- ------ -------
BE2p/ROOT/BE2 - - 36.0K static 2008-05-21 12:26
p/ROOT/BE2/opt - - 18.0K static 2008-05-21 16:26
p/ROOT/BE2/opt@now - - 0 static 2008-09-08 22:43
p/ROOT/BE2@now - - 0 static 2008-09-08 22:43
BE3p/ROOT/BE3 - - 192.0K static 2008-08-26 10:28
p/ROOT/BE3/opt - - 86.0K static 2008-08-26 10:28
p/ROOT/BE3/opt/local - - 36.0K static 2008-08-28 10:58
BE4p/ROOT/BE4 - - 15.78M static 2008-09-05 18:20
BE5p/ROOT/BE5 NR / 6.10G static 2008-09-09 16:53
p/ROOT/BE5/opt - /opt 24.55M static 2008-09-09 16:53
p/ROOT/BE5/opt@bar - - 18.38M static 2008-09-10 00:59
p/ROOT/BE5/opt@foo - - 18.38M static 2008-06-10 16:37
p/ROOT/BE5@bar - - 139.44M static 2008-09-10 00:59
p/ROOT/BE5@foo - - 912.85M static 2008-06-10 16:37
Example 16 Listing Dataset and Snapshot Info for a BEThe following command lists all dataset and snapshot infor-
mation about BE5.SunOS 5.11 Last change: 21 Jul 2010 8
System Administration Commands beadm(1M)
# beadm list -a BE5
BE/Dataset/Snapshot Active Mountpoint Space Policy Created
------------------- ------ ---------- ----- ------ -------
BE5p/ROOT/BE5 NR / 6.10G static 2008-09-09 16:53
p/ROOT/BE5/opt - /opt 24.55M static 2008-09-09 16:53
p/ROOT/BE5/opt@bar - - 18.38M static 2008-09-10 00:59
p/ROOT/BE5/opt@foo - - 18.38M static 2008-06-10 16:37
p/ROOT/BE5@bar - - 139.44M static 2008-09-10 00:59
p/ROOT/BE5@foo - - 912.85M static 2008-06-10 16:37
Example 17 Listing in Machine-Parseable Format
The following command lists information about all BEs inmachine-parseable format.
# beadm list -H
BE2;;;;55296;static;1211397974 BE3;;;;339968;static;1219771706 BE4;;;;16541696;static;1220664051BE5;215b8387-4968-627c-d2d0-f4a011414bab;NR;/;7786206208;static;1221004384
EXIT STATUS 0 Success. >0 Failure. FILES/var/log/beadm/beName/create.log.yyyymmdd_hhmmss
Log used for capturing beadm create output. The time
designation portion of the file name is explained as follows.o yyyymmdd_hhmmss - for example, 20071130_140558.
o yyyy - year, 2007
o mm - month, 11
SunOS 5.11 Last change: 21 Jul 2010 9
System Administration Commands beadm(1M)
o dd - day, 30
o hh - hour, 14
o mm - minute, 05
o ss - second, 58
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | install/beadm |
|_____________________________|_____________________________|
| Interface Stability | Committed ||_____________________________|_____________________________|
SEE ALSO
zfs(1M), attributes(5)SunOS 5.11 Last change: 21 Jul 2010 10