Skip to content

pool

Manage storage pools

Create

Path
POST /v7.0/pools
Description
Create a new storage pool
Authentication required
yes
Scope
pool#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
pool
ParameterTypeRequiredDetails
node
Node
 Resource no
label
Label
 String no

Default: null
filesystem
Filesystem
 String no

Default: null
role
Role
 String no

Show only datasets of certain role

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • hypervisor
  • primary
  • backup

Validation error message: %{value} cannot be used
is_open
Is_open
 Boolean no

Default: null
refquota_check
Refquota check
 Boolean no

Default: null
max_datasets
Max_datasets
 Integer no

Default: null
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • unknown
  • online
  • degraded
  • suspended
  • faulted
  • error

Validation error message: %{value} cannot be used
scan
Scan
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • unknown
  • none
  • scrub
  • resilver
  • error

Validation error message: %{value} cannot be used
scan_percent
Scan_percent
 Float no

Default: null
total_space
Total_space
 Integer no

Default: null
used_space
Used_space
 Integer no

Default: null
available_space
Available_space
 Integer no

Default: null
checked_at
Checked_at
 Datetime no

Default: null
atime
Access time
 Boolean no

Controls whether the access time for files is updated when they are read

Default: false
compression
Compression
 Boolean no

Toggle data compression in this dataset

Default: true
recordsize
Record size
 Integer no

Specifies a suggested block size for files in the file system

Default: 131072
quota
Quota
 Integer no

Limits the amount of space a dataset and all its descendants can consume

Default: 0
refquota
Reference quota
 Integer no

Limits the amount of space a dataset can consume

Default: 0
relatime
Relative access time
 Boolean no

Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours

Default: false
sync
Sync
 String no

Controls the behavior of synchronous requests

Default: standard

Validation rules
RuleDetails
Include

Allowed values:

  • standard
  • disabled

Validation error message: %{value} cannot be used
sharenfs
NFS share
 String no

Controls NFS sharing

Default: ""

Output parameters

Layout
object
Namespace
pool
ParameterTypeDescription
id
Id
 Integer
node
Node
 Resource
label
Label
 String
name
Name
 String
filesystem
Filesystem
 String
role
Role
 String Show only datasets of certain role
is_open
Is_open
 Boolean
refquota_check
Refquota check
 Boolean
max_datasets
Max_datasets
 Integer
state
State
 String
scan
Scan
 String
scan_percent
Scan_percent
 Float
total_space
Total_space
 Integer
used_space
Used_space
 Integer
available_space
Available_space
 Integer
checked_at
Checked_at
 Datetime
atime
Access time
 Boolean Controls whether the access time for files is updated when they are read
compression
Compression
 Boolean Toggle data compression in this dataset
recordsize
Record size
 Integer Specifies a suggested block size for files in the file system
quota
Quota
 Integer Limits the amount of space a dataset and all its descendants can consume
refquota
Reference quota
 Integer Limits the amount of space a dataset can consume
relatime
Relative access time
 Boolean Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours
sync
Sync
 String Controls the behavior of synchronous requests
sharenfs
NFS share
 String Controls NFS sharing
used
Used space
 Integer Amount of space used by dataset
referenced
Referenced space
 Integer Amount of space that is accessible to this dataset
avail
Available space
 Integer Amount of space left in dataset
compressratio
Used compression ratio
 Float Compression ratio for used space of this dataset
refcompressratio
Referenced compression ratio
 Float Compression ratio for referenced space of this dataset

Index

Path
GET /v7.0/pools
Description
List storage pools
Authentication required
yes
Scope
pool#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
pool
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
node
Node
 Resource no
label
Label
 String no

Default: null
name
Name
 String no

Default: null
filesystem
Filesystem
 String no

Default: null
role
Role
 String no

Show only datasets of certain role

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • hypervisor
  • primary
  • backup

Validation error message: %{value} cannot be used
is_open
Is_open
 Boolean no

Default: null
refquota_check
Refquota check
 Boolean no

Default: null
max_datasets
Max_datasets
 Integer no

Default: null
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • unknown
  • online
  • degraded
  • suspended
  • faulted
  • error

Validation error message: %{value} cannot be used
scan
Scan
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • unknown
  • none
  • scrub
  • resilver
  • error

Validation error message: %{value} cannot be used
scan_percent
Scan_percent
 Float no

Default: null
total_space
Total_space
 Integer no

Default: null
used_space
Used_space
 Integer no

Default: null
available_space
Available_space
 Integer no

Default: null
checked_at
Checked_at
 Datetime no

Default: null
atime
Access time
 Boolean no

Controls whether the access time for files is updated when they are read

Default: false
compression
Compression
 Boolean no

Toggle data compression in this dataset

Default: true
recordsize
Record size
 Integer no

Specifies a suggested block size for files in the file system

Default: 131072
quota
Quota
 Integer no

Limits the amount of space a dataset and all its descendants can consume

Default: 0
refquota
Reference quota
 Integer no

Limits the amount of space a dataset can consume

Default: 0
relatime
Relative access time
 Boolean no

Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours

Default: false
sync
Sync
 String no

Controls the behavior of synchronous requests

Default: standard

Validation rules
RuleDetails
Include

Allowed values:

  • standard
  • disabled

Validation error message: %{value} cannot be used
sharenfs
NFS share
 String no

Controls NFS sharing

Default: ""

Output parameters

Layout
object_list
Namespace
pools
ParameterTypeDescription
id
Id
 Integer
node
Node
 Resource
label
Label
 String
name
Name
 String
filesystem
Filesystem
 String
role
Role
 String Show only datasets of certain role
is_open
Is_open
 Boolean
refquota_check
Refquota check
 Boolean
max_datasets
Max_datasets
 Integer
state
State
 String
scan
Scan
 String
scan_percent
Scan_percent
 Float
total_space
Total_space
 Integer
used_space
Used_space
 Integer
available_space
Available_space
 Integer
checked_at
Checked_at
 Datetime
atime
Access time
 Boolean Controls whether the access time for files is updated when they are read
compression
Compression
 Boolean Toggle data compression in this dataset
recordsize
Record size
 Integer Specifies a suggested block size for files in the file system
quota
Quota
 Integer Limits the amount of space a dataset and all its descendants can consume
refquota
Reference quota
 Integer Limits the amount of space a dataset can consume
relatime
Relative access time
 Boolean Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours
sync
Sync
 String Controls the behavior of synchronous requests
sharenfs
NFS share
 String Controls NFS sharing
used
Used space
 Integer Amount of space used by dataset
referenced
Referenced space
 Integer Amount of space that is accessible to this dataset
avail
Available space
 Integer Amount of space left in dataset
compressratio
Used compression ratio
 Float Compression ratio for used space of this dataset
refcompressratio
Referenced compression ratio
 Float Compression ratio for referenced space of this dataset
maintenance_lock
Maintenance lock
 String
maintenance_lock_reason
Maintenance reason
 String

Set_maintenance

Path
POST /v7.0/pools/{pool_id}/set_maintenance
Description
Set maintenance lock
Authentication required
yes
Scope
pool#set_maintenance
Aliases
Blocking
no

Input parameters

Layout
hash
Namespace
pool
ParameterTypeRequiredDetails
lock
Lock
 Boolean yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
reason
Reason
 String no

Default: ""

Output parameters

No parameters.

Show

Path
GET /v7.0/pools/{pool_id}
Description
Show storage pool
Authentication required
yes
Scope
pool#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
pool
ParameterTypeDescription
id
Id
 Integer
node
Node
 Resource
label
Label
 String
name
Name
 String
filesystem
Filesystem
 String
role
Role
 String Show only datasets of certain role
is_open
Is_open
 Boolean
refquota_check
Refquota check
 Boolean
max_datasets
Max_datasets
 Integer
state
State
 String
scan
Scan
 String
scan_percent
Scan_percent
 Float
total_space
Total_space
 Integer
used_space
Used_space
 Integer
available_space
Available_space
 Integer
checked_at
Checked_at
 Datetime
atime
Access time
 Boolean Controls whether the access time for files is updated when they are read
compression
Compression
 Boolean Toggle data compression in this dataset
recordsize
Record size
 Integer Specifies a suggested block size for files in the file system
quota
Quota
 Integer Limits the amount of space a dataset and all its descendants can consume
refquota
Reference quota
 Integer Limits the amount of space a dataset can consume
relatime
Relative access time
 Boolean Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours
sync
Sync
 String Controls the behavior of synchronous requests
sharenfs
NFS share
 String Controls NFS sharing
used
Used space
 Integer Amount of space used by dataset
referenced
Referenced space
 Integer Amount of space that is accessible to this dataset
avail
Available space
 Integer Amount of space left in dataset
compressratio
Used compression ratio
 Float Compression ratio for used space of this dataset
refcompressratio
Referenced compression ratio
 Float Compression ratio for referenced space of this dataset
maintenance_lock
Maintenance lock
 String
maintenance_lock_reason
Maintenance reason
 String