Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Driver pool.zpool

Minimal configlet:

[pool#1]
type = zpool
name = 

Minimal setup command:

om test/ccfg/foo set \
	--kw="type=zpool" \
	--kw="name="

Supported keywords:

  • max_peers
  • mkblk_opt
  • mkfs_opt
  • mnt_opt
  • name
  • status_schedule
  • type

Keyword max_peers

required:    false
scopable:    false
convert:     int

Example:

max_peers=8

Description:

Keyword mkblk_opt

required:    false
scopable:    false

Description:

The zvol, lv, and other block device creation command options to use to prepare the pool devices.

Keyword mkfs_opt

required:    false
scopable:    false

Example:

mkfs_opt=-O largefile

Description:

The mkfs command options to use to format the pool devices.

Keyword mnt_opt

required:    false
scopable:    true

Description:

The mount options of the fs created over the pool devices.

Keyword name

required:    true
scopable:    false

Description:

The name of the zpool to allocate the pool volumes zvol or datasets into.

Keyword status_schedule

required:    false
scopable:    false

Description:

The value to set to the status_schedule keyword of the vol objects allocated from the pool.

See usr/share/doc/schedule for the schedule syntax.

Keyword type

required:    false
scopable:    false
candidates:  directory, loop, vg, zpool, freenas, share, shm, symmetrix, truenas, virtual, dorado, hoc, drbd, pure, rados
default:     directory

Description:

The pool type.