beadm

Displays command usage.

beadm activate

Makes beName the active BE on next reboot.

Syntax: beadm activate beName

beadm create

Creates a new boot environment name, beName. Unless the -e option is provided, the new BE is created as a clone of the currently running BE.

Syntax: beadm create [-a] [-e non-activeBeName | beName@snapshot] [-o property=value] ...[-p zpool] beName

• -a – Activate the newly created BE upon creation. The default is to not activate the newly created BE.

• -e non-activeBeName – Create a new BE from an existing, inactive BE. The default is to create the BE from the active BE.

• -e beName@snapshot – Create a new BE from an existing snapshot of the BE named beName.

• -o property=value – Create the datasets for new BE with specific ZFS properties. 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 option is not provided, the default behavior is to create the new BE in the same pool as the original BE.

• beName – Name of the boot environment to create.

• beName@snapshot – Name of an existing snapshot of the BE named beName.

beadm create beName@snapshot

Creates a snapshot of the existing BE named beName.

Syntax: beadm create beName@snapshot

beName@snapshot – The snapshot name must use the format, beName@snapshotdescription, where be is the name of an existing boot environment that you want to make a snapshot from. Enter a custom snapshotdescription to identify the date or purpose of the snapshot.

beadm destroy

Destroys the boot environment named beName or destroys an existing snapshot of the boot environment named beName.

Syntax: beadm destroy [-f] beName | beName@snapshot

-f – Does not prompt for confirmation to destroy BE.

beadm list

Lists information about the existing boot environment which is beName, or lists information for all boot environments if beName is not provided.

Syntax: beadm list [-a | [-ds] [-H] [beName]

• -a – Lists all available information about the boot environment. This information includes subordinate file systems and snapshots.

• -d – Lists information about all subordinate file systems that belong to the boot environment.

• -s – Lists information about the snapshots of the boot environment.

• -H – Prevents listing header information.

  Example displays without header:

  BE2:no:yes:mounted:/pool1/BE/BE2:6.2G;;;

  Without header information, the display information is identified by the following delimiters:

  • ; – Delimits BEs, datasets, zones, and snapshots.

  • : – Delimits attributes for BEs, datasets, zones, and snapshots.

  • , – Delimits multiple datasets, zones, and snapshots.

  • Multiple BEs are delimited with a return (blank line).

  ---

  Note - The -p option can be combined with the other options.

  ---

• beName - If beName is not provided, the command results display information for all BEs. The default is to list BEs without any additional information.

beadm mount

Mounts a boot environment named beName at mount point. The mount point must be an already existing, empty directory.

Syntax: beadm mount beName mountpoint

beadm rename

Renames the boot environment named beName to newBeName.

Syntax: beadm rename beName newBeName

beadm unmount

Unmounts the boot environment named beName.

Syntax: beadm unmount beName