iscsi.extent.get_instance

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

Please see query method documentation for options.

Type: object

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

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

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

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:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Example:

[
    "username",
    "Authentication.status"
]

Count

Type: boolean Default: false

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

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

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

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

Type: boolean Default: false

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

IscsiExtentEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the iSCSI extent.

Name

Type: string

Name of the iSCSI extent.

Must be at least 1 characters long

Must be at most 64 characters long

Type

Type: enum (of string) Default: "DISK"

Type of the extent storage backend.

Must be one of:
  • "DISK"
  • "FILE"

Disk

Default: null

Disk device to use for the extent or null if using a file.

Type: string
Type: null

Serial

Default: null

Serial number for the extent or null to auto-generate.

Type: string
Type: null

Path

Default: null

File path for file-based extents or null if using a disk.

Type: string
Type: null

Filesize

Default: "0"

Size of the file-based extent in bytes.

Type: string
Type: integer

Blocksize

Type: enum (of integer) Default: 512

Block size for the extent in bytes.

Must be one of:
  • 512
  • 1024
  • 2048
  • 4096

Pblocksize

Type: boolean Default: false

Whether to use physical block size reporting.

Avail Threshold

Default: null

Available space threshold percentage or null to disable.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 99

Type: null

Comment

Type: string Default: ""

Optional comment describing the extent.

Naa

Type: string

Network Address Authority (NAA) identifier for the extent.

Must be at most 34 characters long

Insecure Tpc

Type: boolean Default: true

Whether to enable insecure Third Party Copy (TPC) operations.

Xen

Type: boolean Default: false

Whether to enable Xen compatibility mode.

Rpm

Type: enum (of string) Default: "SSD"

Reported RPM type for the extent.

Must be one of:
  • "UNKNOWN"
  • "SSD"
  • "5400"
  • "7200"
  • "10000"
  • "15000"

Ro

Type: boolean Default: false

Whether the extent is read-only.

Enabled

Type: boolean Default: true

Whether the extent is enabled and available for use.

Vendor

Type: string

Vendor string reported by the extent.

Product Id

Default: null

Product ID string for the extent or null for default.

Type: string

Must be at least 1 characters long

Must be at most 16 characters long

Type: null

Locked


Read-only value indicating whether the iscsi extent is located on a locked dataset.

  • true: The extent is in a locked dataset.
  • false: The extent is not in a locked dataset.
  • null: Lock status is not available because path locking information was not requested.

Type: boolean
Type: null


Required roles: SHARING_ISCSI_EXTENT_READ