pool.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: options

options

Type: object Default: {}

Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

extra

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

order_by

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).

No Additional Items

Each item of this array must be:

Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

select

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.

No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

get

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.

offset

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

limit

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Return value

PoolEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for this storage pool.

name Required

Name

Type: string

Name of the storage pool.

guid Required

Guid

Type: string

Globally unique identifier (GUID) for this pool.

status Required

Status

Type: string

Current status of the pool.

Examples:

"ONLINE"

"DEGRADED"

"FAULTED"

path Required

Path

Type: string

Filesystem path where the pool is mounted.

scan Required

Scan

Information about any active scrub or resilver operation. null if no operation is running.

Any of

• Option 1
• Option 2

Type: object

Example:

{
    "bytes_issued": null,
    "bytes_processed": null,
    "bytes_to_process": null,
    "end_time": null,
    "errors": null,
    "function": null,
    "pause": null,
    "percentage": null,
    "start_time": null,
    "state": null,
    "total_secs_left": null
}

Type: null

expand Required

Expand

Information about any active pool expansion operation. null if no expansion is running.

Any of

• Option 1
• Option 2

Type: object

Example:

{
    "bytes_reflowed": 978944,
    "bytes_to_reflow": 835584,
    "end_time": null,
    "expanding_vdev": 0,
    "percentage": 85.35564853556485,
    "start_time": null,
    "state": "FINISHED",
    "total_secs_left": null,
    "waiting_for_resilver": 0
}

Type: null

is_upgraded

Is Upgraded

Type: boolean Default: false

Whether this pool has been upgraded to the latest feature flags.

healthy Required

Healthy

Type: boolean

Whether the pool is in a healthy state with no errors or warnings.

warning Required

Warning

Type: boolean

Whether the pool has warning conditions that require attention.

status_code Required

Status Code

Detailed status code for the pool condition. null if not applicable.

Any of

• Option 1
• Option 2

Type: string

Type: null

status_detail Required

Status Detail

Human-readable description of the pool status. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

size Required

Size

Total size of the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

allocated Required

Allocated

Amount of space currently allocated in the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

free Required

Free

Amount of free space available in the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

freeing Required

Freeing

Amount of space being freed (in bytes) by ongoing operations. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

dedup_table_size Required

Dedup Table Size

Size of the deduplication table in bytes. null if deduplication is not enabled.

Any of

• Option 1
• Option 2

Type: integer

Type: null

dedup_table_quota Required

Dedup Table Quota

Quota limit for the deduplication table. null if no quota is set.

Any of

• Option 1
• Option 2

Type: string

Type: null

fragmentation Required

Fragmentation

Percentage of pool fragmentation as a string. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

size_str Required

Size Str

Human-readable string representation of the pool size. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

allocated_str Required

Allocated Str

Human-readable string representation of allocated space. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

free_str Required

Free Str

Human-readable string representation of free space. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

freeing_str Required

Freeing Str

Human-readable string representation of space being freed. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

autotrim Required

Autotrim

Type: object

Auto-trim configuration for the pool indicating whether automatic TRIM operations are enabled.

Example:

{
    "parsed": "off",
    "rawvalue": "off",
    "source": "DEFAULT",
    "value": "off"
}

topology Required

Physical topology and structure of the pool including vdevs. null if not available.

Any of

• PoolTopology
• Option 2

PoolTopology

Type: object
No Additional Properties

data Required

Data

Type: array

Array of data vdev configurations in the pool.

No Additional Items

Each item of this array must be:

Type: object

log Required

Log

Type: array

Array of ZFS Intent Log (ZIL) vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

cache Required

Cache

Type: array

Array of L2ARC cache vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

spare Required

Spare

Type: array

Array of spare disk configurations.

No Additional Items

Each item of this array must be:

Type: object

special Required

Special

Type: array

Array of special vdev configurations for metadata.

No Additional Items

Each item of this array must be:

Type: object

dedup Required

Dedup

Type: array

Array of deduplication table vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

Type: null

Required roles: POOL_READ