# Driver `pool.truenas`

**Minimal configlet:**

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

**Minimal setup command:**

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

**Supported keywords:**

- array
- blocksize
- comment
- compression
- dedup
- diskgroup
- fs_type
- insecure_tpc
- mkblk_opt
- mkfs_opt
- mnt_opt
- sparse
- status_schedule
- type

## Keyword `array`

	required:    true
	scopable:    true

**Description:**

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


## Keyword `blocksize`

	required:    false
	scopable:    false
	default:     512
	convert:     size

**Description:**

The block size of the zvol created for a volume of this pool.


## Keyword `comment`

	required:    false
	scopable:    false

**Description:**

A free form text describing the role of the object, of the node, or of the
section it is set in.

The keyword is accepted in any section, so the DEFAULT section can document a
configuration as a whole, and a resource, pool, heartbeat, array or network
section can document itself.

The agent does not interpret the value.


## Keyword `compression`

	required:    false
	scopable:    false
	candidates:  inherit, none, lz4, gzip-1, gzip-2, gzip-3, gzip-4, gzip-5, gzip-6, gzip-7, gzip-8, gzip-9, zle, lzjb
	default:     inherit

**Description:**

Compression level.


## Keyword `dedup`

	required:    false
	scopable:    false
	default:     off

**Description:**

Activate data deduplication on created dataset and zvol. Example values: on, off, verify


## 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 `insecure_tpc`

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

**Description:**

Allow initiators to xcopy without authenticating to foreign targets.


## Keyword `mkblk_opt`

	required:    false
	scopable:    false

**Example:**

	mkblk_opt=-b 16k

**Description:**

The zvol, lv, and other block device creation command options to use to
prepare the pool volumes 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 `sparse`

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

**Description:**

Create zvol in sparse mode.


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