beadm – Manage ZFS boot environments on FreeBSD/Solaris/illumos systems¶
Synopsis¶
- Create, delete or activate ZFS boot environments.
- Mount and unmount ZFS boot environments.
Parameters¶
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, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Adam Števko (@xen0l)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
