nvmet.namespace.get_instance¶
Returns instance matching id. If id is not found, Validation error is raised.
Please see query method documentation for options.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 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.
Relationships
Type: boolean Default: trueExtend
Default: nullExtend Fk
Type: array of string Default: []No Additional Items
Each item of this array must be:
Extend Context
Default: nullPrefix
Default: nullExtra
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).
Each item of this array must be:
[
"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.
Each item of this array must be:
No Additional Items
Each item of this array must be:
[
"username",
"Authentication.status"
]
Count
Type: boolean Default: falseReturn a numeric value representing the number of items that match the specified query-filters.
Get
Type: boolean Default: falseReturn 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: 0This 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: 0This 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: falseNVMetNamespaceEntry
Type: objectNo Additional Properties
Id
Type: integerNsid
Default: nullNamespace ID (NSID)
Each namespace within a subsystem has an associated NSID, unique within that subsystem.
If not supplied during namespace creation then the next available NSID will be used.
Value must be greater or equal to 1 and strictly lesser than 4294967295
NVMetSubsysEntry
Type: objectNo Additional Properties
Id
Type: integerName
Type: stringHuman readable name for the subsystem.
If subnqn is not provided on creation, then this name will be appended to the basenqn from nvmet.global.config to generate a subnqn.
Must be at least 1 characters long
Subnqn
Default: nullMust be at least 1 characters long
Must be at most 223 characters long
Serial
Type: stringAllow Any Host
Type: boolean Default: falseIf True then any host can access the storage associated with this subsystem (i.e. no access control).
Pi Enable
Default: nullQid Max
Default: nullIeee Oui
Default: nullAna
Default: nullIf set to either True or False then override the global ana setting from nvmet.global.config for this subsystem only.
If null then the global ana setting will take effect.
Hosts
Default: []List of host ids which have access to this subsystem.
Only populated on query if extra.options.verbose is set.
No Additional Items
Each item of this array must be:
Namespaces
Default: []List of namespaces ids in this subsystem.
Only populated on query if extra.options.verbose is set.
No Additional Items
Each item of this array must be:
Ports
Default: []List of ports ids on which this subsystem is available.
Only populated on query if extra.options.verbose is set.
No Additional Items
Each item of this array must be:
Device Type
Type: enum (of string)Type of device (or file) used to implement the namespace.
Must be one of:
- "ZVOL"
- "FILE"
Device Path
Type: stringPath to the device or file being used to implement the namespace.
When device_type is "ZVOL" then this path is e.g. "zvol/poolname/zvolname"
When device_type is "FILE" then this path is e.g. "/mnt/poolmnt/path/to/file". The file will be created if necessary.
Filesize
Default: nullWhen device_type is "FILE" then this will be the size of the file in bytes.
Device Uuid
Type: stringMust be at least 1 characters long
Device Nguid
Type: stringMust be at least 1 characters long
Enabled
Type: boolean Default: trueIf enabled is False then the namespace will not be accessible.
Some namespace configuration changes are blocked when that namespace is enabled.
Locked
Reflect the locked state of the namespace.
The underlying device_path could be an encrypted ZVOL, or a file on an encrypted dataset. In either case locked will be True if the underlying entity is locked.
Required roles: SHARING_NVME_TARGET_READ