New in version 2.3.
Parameter | Choices/Defaults | Comments |
---|---|---|
description | Default: no | Associate a description with a new boot environment. This option is available only on Solarish platforms. |
force bool |
| Specifies if the unmount should be forced. |
mountpoint | Default: no | Path where to mount the ZFS boot environment |
name required | ZFS boot environment name. aliases: be | |
options | Default: 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 | Default: no | If specified, the new boot environment will be cloned from the given snapshot or inactive boot environment. |
state |
| Create or delete ZFS boot environment. |
- 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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
description string | always | BE description Sample: Upgrade from 9.0 to 10.0 |
force boolean | always | if forced action is wanted |
mountpoint string | always | BE mountpoint Sample: /mnt/be |
name string | always | BE name Sample: pre-upgrade |
options string | always | BE additional options Sample: compression=on |
snapshot string | always | ZFS snapshot to create BE from Sample: rpool/ROOT/oi-hipster@fresh |
state string | always | state of the target Sample: present |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/beadm_module.html