Boot Environment Options

A new BE or a backup BE might be created automatically when you install, update, or uninstall a package. Within the constraints of the image policy regarding BEs, you can control the creation of new and backup BEs using the options described below. See Boot Environment Policy Image Properties for information about new BEs and backup BEs and how to set image policy regarding BEs.

Use the following BE options to force a new BE or backup BE to be created or not created, to give the BE a custom name, and to specify that the new BE should not be activated. These options are available for the install, exact-install, uninstall, update, revert, set-mediator, unset-mediator, change-variant, and change-facet subcommands.

Note:

Options to create a new or backup BE are ignored if the BE on which you are operating is not the currently active BE. When the BE on which you are operating is not the currently active BE, changes are made directly to that image. See the description of the -R option and the PKG_IMAGE environment variable in the pkg(1) man page.

--no-be-activate

If a BE is created, do not set it as the active BE on the next boot.

In the command output, note any messages that say a new boot environment has been created. If a new boot environment has been created and activated, that BE is booted by default on the next reboot if you do not specify the --no-be-activate option.

Use the beadm command as described in the beadm(8) man page to show and change the active BE.

--no-backup-be

Do not create a backup BE.

--require-backup-be

Create a backup BE if a new BE will not be created. Without this option, a backup BE is created based on image policy. See Boot Environment Policy Image Properties for an explanation of when backup BEs are created automatically.

--backup-be-name name

If a backup BE is created, name it name instead of a default name. Use of --backup-be-name implies --require-backup-be.

--deny-new-be

Do not create a new BE. The install, update, uninstall, or revert operation is not performed if a new BE is required.

--require-new-be

Create a new BE. Without this option, a BE is created based on image policy. See Boot Environment Policy Image Properties for an explanation of when BEs are created automatically. This option cannot be combined with --require-backup-be.

--be-name name

If a BE is created, name it name instead of a default name. Use of --be-name implies --require-new-be. Using this option is the safest way to perform operations