salt.modules.zpool

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »

# salt.modules.zpool

zfs support.

Assumes FreeBSD

requires: mkfile

`salt.modules.zpool.` `add`(pool_name, vdisk)

  Add a single device to mirror

  CLI Example:

      salt '*' zfs.add myzpool /disk2

`salt.modules.zpool.` `create_file_vdevice`(size, *names)

  creates file based `virtual devices` for a zpool

  `*names` is a list of full paths for mkfile to create

  CLI Example:

      salt '*' zfs.create_file_vdevice 7g /disk1 /disk2

      Depending on file size this may take a while to return

`salt.modules.zpool.` `list_installed`()

  returns a list of installed packages

`salt.modules.zpool.` `pool_exists`(pool_name)

  Check if a zfs storage pool is active

`salt.modules.zpool.` `replace`(pool_name, old, new)

  Replace a disk in a pool with another disk.

  CLI Example:

      salt '*' zfs.replace myzpool /disk1 /disk2

`salt.modules.zpool.` `zpool_create`(pool_name, *disks)

  Create a simple storage pool

  CLI Example:

      salt '*' zfs.zpool_create myzpool /disk1 /disk2

`salt.modules.zpool.` `zpool_destory`(pool_name)

  Destorys a storage pool

  CLI Example:

      salt '*' zfs.zpool_destory myzpool

`salt.modules.zpool.` `zpool_detach`(zpool, device)

  Detach a device from a storage pool

  CLI Example:

      salt '*' zfs.detach myzpool /disk1

`salt.modules.zpool.` `zpool_list`()

  list zpool's size and usage

`salt.modules.zpool.` `zpool_status`(name=None)

## Comments

comments powered by Disqus

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »