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.pure

Minimal configlet:

[pool#1]
type = pure
array = 
diskgroup = 

Minimal setup command:

om node set \
	--kw="type=pure" \
	--kw="array=" \
	--kw="diskgroup="

Supported keywords:

  • array
  • delete_now
  • diskgroup
  • fs_type
  • label_prefix
  • max_peers
  • mkblk_opt
  • mkfs_opt
  • mnt_opt
  • pod
  • status_schedule
  • type
  • volumegroup

Keyword array

required:    true
scopable:    true

Description:

The name of the array, known as array#<name> in the node or cluster configuration.

Keyword delete_now

required:    false
scopable:    false
default:     true
convert:     bool

Description:

If set to false the pure volumes are not immediately deleted on unprovision, so a following provision action could fail.

Keyword diskgroup

required:    true
scopable:    false

Description:

The name of the array disk group to allocate volumes from.

Keyword fs_type

required:    false
scopable:    false
default:     xfs

Description:

The filesystem to format the pool devices with.

Keyword label_prefix

required:    false
scopable:    false

Description:

The prefix to add to the label assigned to the created disks.

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 pod

required:    false
scopable:    false

Description:

The pod to create volume 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.

Keyword volumegroup

required:    false
scopable:    false

Description:

The volumegroup to create volume disks into.