disk.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: string

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

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_fk

Extend Fk

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

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

Return value

DiskEntry

Type: object
No Additional Properties

identifier Required

Identifier

Type: string

name Required

Name

Type: string

subsystem Required

Subsystem

Type: string

number Required

Number

Type: integer

serial Required

Serial

Type: string

lunid Required

Lunid

Any of

• Option 1
• Option 2

Type: string

Type: null

size Required

Size

Any of

• Option 1
• Option 2

Type: integer

Type: null

description Required

Description

Type: string

transfermode Required

Transfermode

Type: string

hddstandby Required

Hddstandby

Type: enum (of string)

Must be one of:

• "ALWAYS ON"
• "5"
• "10"
• "20"
• "30"
• "60"
• "120"
• "180"
• "240"
• "300"
• "330"

advpowermgmt Required

Advpowermgmt

Type: enum (of string)

Must be one of:

• "DISABLED"
• "1"
• "64"
• "127"
• "128"
• "192"
• "254"

expiretime Required

Expiretime

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

model Required

Model

Any of

• Option 1
• Option 2

Type: string

Type: null

rotationrate Required

Rotationrate

Any of

• Option 1
• Option 2

Type: integer

Type: null

type Required

Type

Any of

• Option 1
• Option 2

Type: string

Type: null

zfs_guid Required

Zfs Guid

Any of

• Option 1
• Option 2

Type: string

Type: null

bus Required

Bus

Type: string

devname Required

Devname

Type: string

enclosure Required

Any of

• DiskEntryEnclosure
• Option 2

DiskEntryEnclosure

Type: object
No Additional Properties

number Required

Number

Type: integer

slot Required

Slot

Type: integer

Type: null

pool Required

Pool

Any of

• Option 1
• Option 2

Type: string

Type: null

passwd

Passwd

Type: string

kmip_uid

Kmip Uid

Any of

• Option 1
• Option 2

Type: string

Type: null

Required roles: DISK_READ