community.general.beadm 模块 – 在 FreeBSD/Solaris/illumos 系统上管理 ZFS 启动环境

注意

此模块是 community.general 集合(版本 10.1.0)的一部分。

如果您正在使用 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install community.general

要在 playbook 中使用它,请指定:community.general.beadm

概要

  • 创建、删除或激活 ZFS 启动环境。

  • 挂载和卸载 ZFS 启动环境。

参数

参数

注释

description

字符串

将描述与新的启动环境关联。此选项仅在 Solarish 平台上可用。

force

布尔值

指定是否应强制卸载。

选择

  • false ← (默认)

  • true

mountpoint

路径

挂载 ZFS 启动环境的路径。

name

别名: be

字符串 / 必需

ZFS 启动环境名称。

options

字符串

使用特定的 ZFS 属性为新的 BE 创建数据集。

可以指定多个选项。

此选项仅在 Solarish 平台上可用。

snapshot

字符串

如果指定,新的启动环境将从给定的快照或非活动启动环境克隆。

state

字符串

创建或删除 ZFS 启动环境。

选择

  • "absent"

  • "activated"

  • "mounted"

  • "present" ← (默认)

  • "unmounted"

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 中运行,并返回已更改状态预测,而无需修改目标。

diff_mode

支持:

当处于差异模式时,将返回有关已更改内容(或可能需要在 check_mode 中更改的内容)的详细信息。

示例

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

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

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

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

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

- name: Unmount ZFS boot environment
  community.general.beadm:
    name: BE
    state: unmounted

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

返回值

常见返回值已在此处记录:此处,以下是此模块独有的字段

描述

description

字符串

BE 描述

返回: 始终

示例: "从 9.0 升级到 10.0"

force

布尔值

是否需要强制操作

返回: 始终

示例: false

mountpoint

字符串

BE 挂载点

返回: 始终

示例: "/mnt/be"

name

字符串

BE 名称

返回: 始终

示例: "pre-upgrade"

options

字符串

BE 其他选项

返回: 始终

示例: "compression=on"

snapshot

字符串

从中创建 BE 的 ZFS 快照

返回: 始终

示例: "rpool/ROOT/oi-hipster@fresh"

state

字符串

目标的状态

返回: 始终

示例: "present"

作者

  • Adam Števko (@xen0l)