---
name: "ocf_heartbeat_ZFS"
section: "7"
platform: "linux"
package: "resource-agents"
version: "1:4.16.0-3+deb13u2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/ocf_heartbeat_ZFS"
---

# ocf\_heartbeat\_ZFS(7)

Manages ZFS pools

## NAME

ocf\_heartbeat\_ZFS - Manages ZFS pools

## SYNOPSIS

**ZFS** \[start \| stop \| monitor \| meta-data \| validate-all\]

## DESCRIPTION

This script manages ZFS pools It can import a ZFS pool or export it

## SUPPORTED PARAMETERS

**pool**

The name of the ZFS pool to manage, e.g. "tank".

(unique, required, string, no default)

**importargs**

Arguments to zpool import, e.g. "-d /dev/disk/by-id".

(optional, string, no default)

**importforce**

zpool import is given the -f option.

(optional, boolean, default true)

## SUPPORTED ACTIONS

This resource agent supports the following actions (operations):

**start**

Starts the resource. Suggested minimum timeout: 60s.

**stop**

Stops the resource. Suggested minimum timeout: 60s.

**monitor**

Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 5s.

**validate-all**

Performs a validation of the resource configuration. Suggested minimum timeout: 30s.

**meta-data**

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL

The following is an example configuration for a ZFS resource using the [**crm**(8)](/crm/8.md) shell:

```
primitive p_ZFS ocf:heartbeat:ZFS \
  params \
    pool=string \
  op monitor depth="0" timeout="30s" interval="5s"
```

## EXAMPLE PCS

The following is an example configuration for a ZFS resource using [**pcs**(8)](/pcs/8.md)

```
pcs resource create p_ZFS ocf:heartbeat:ZFS \
  pool=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="5s"
```

## SEE ALSO

**http://clusterlabs.org/**

## AUTHOR

**ClusterLabs contributors (see the resource agent source for information about individual authors)**
