interface.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: stringParameter 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: falseInterfaceEntry
Type: objectId
Type: stringName
Type: stringFake
Type: booleanType
Type: stringInterfaceEntryState
Type: objectNo Additional Properties
Name
Type: stringOrig Name
Type: stringDescription
Type: stringMtu
Type: integerCloned
Type: booleanFlags
Type: array of stringNo Additional Items
Each item of this array must be:
Nd6 Flags
Type: arrayNo Additional Items
Each item of this array must be:
Capabilities
Type: arrayNo Additional Items
Each item of this array must be:
Link State
Type: stringMedia Type
Type: stringMedia Subtype
Type: stringActive Media Type
Type: stringActive Media Subtype
Type: stringSupported Media
Type: arrayNo Additional Items
Each item of this array must be:
Media Options
No Additional Items
Each item of this array must be:
Link Address
Type: stringPermanent Link Address
Hardware Link Address
Type: stringRx Queues
Type: integerTx Queues
Type: integerAliases
Type: array of objectNo Additional Items
Each item of this array must be:
InterfaceEntryStateAlias
Type: objectNo Additional Properties
Type
Type: stringAddress
Type: stringNetmask
Broadcast
Type: stringVrrp Config
Default: []No Additional Items
Each item of this array must be:
Protocol
Ports
Type: array of object Default: []No Additional Items
Each item of this array must be:
InterfaceEntryStatePort
Type: objectNo Additional Properties
Name
Type: stringFlags
Type: array of stringNo Additional Items
Each item of this array must be:
Xmit Hash Policy
Default: nullLacpdu Rate
Default: nullParent
Tag
Pcp
Aliases
Type: array of objectNo Additional Items
Each item of this array must be:
InterfaceEntryAlias
Type: objectNo Additional Properties
Type
Type: stringAddress
Type: stringNetmask
Ipv4 Dhcp
Type: booleanIpv6 Auto
Type: booleanDescription
Type: stringMtu
Vlan Parent Interface
Vlan Tag
Vlan Pcp
Lag Protocol
Type: stringLag Ports
Type: array of string Default: []No Additional Items
Each item of this array must be:
Bridge Members
Type: array of string Default: []No Additional Items
Each item of this array must be:
Enable Learning
Type: booleanAdditional Properties of any type are allowed.
Type: objectRequired roles: NETWORK_INTERFACE_READ