Documentation

beadm - Manage ZFS boot environments on FreeBSD/Solaris/illumos systems.

New in version 2.3.

Synopsis

  • Create, delete or activate ZFS boot environments.
  • Mount and unmount ZFS boot environments.

Options

parameter required default choices comments
description
 no
Associate a description with a new boot environment. This option is available only on Solarish platforms.
force
 no
  • true
  • false
Specifies if the unmount should be forced.
mountpoint
 no
Path where to mount the ZFS boot environment
name
 yes
ZFS boot environment name.

aliases: be
options
 no
Create the datasets for new BE with specific ZFS properties. Multiple options can be specified. This option is available only on Solarish platforms.
snapshot
 no
If specified, the new boot environment will be cloned from the given snapshot or inactive boot environment.
state
 no present
  • present
  • absent
  • activated
  • mounted
  • unmounted
Create or delete ZFS boot environment.

Examples

- name: Create ZFS boot environment
  beadm:
    name: upgrade-be
    state: present

- name: Create ZFS boot environment from existing inactive boot environment
  beadm:
    name: upgrade-be
    snapshot: be@old
    state: present

- name: Create ZFS boot environment with compression enabled and description "upgrade"
  beadm:
    name: upgrade-be
    options: "compression=on"
    description: upgrade
    state: present

- name: Delete ZFS boot environment
  beadm:
    name: old-be
    state: absent

- name: Mount ZFS boot environment on /tmp/be
  beadm:
    name: BE
    mountpoint: /tmp/be
    state: mounted

- name: Unmount ZFS boot environment
  beadm:
    name: BE
    state: unmounted

- name: Activate ZFS boot environment
  beadm:
    name: upgrade-be
    state: activated

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
state state of the target always string present
force if forced action is wanted always boolean False
name BE name always string pre-upgrade
mountpoint BE mountpoint always string /mnt/be
snapshot ZFS snapshot to create BE from always string rpool/ROOT/oi-hipster@fresh
options BE additional options always string compression=on
description BE description always string Upgrade from 9.0 to 10.0


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.