sharing.nfs.get_instance ======================== Returns instance matching `id`. If `id` is not found, Validation error is raised. Please see `query` method documentation for `options`. .. raw:: html
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.

NfsShareEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the NFS share.

Path

Type: string

Local path to be exported.

Must be at least 1 characters long

Aliases

Type: array of string Default: []

IGNORED for now.

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

Must be at least 1 characters long

Comment

Type: string Default: ""

User comment associated with share.

Networks

Type: array of string Default: []

List of authorized networks that are allowed to access the share having format "network/mask" CIDR notation. Each entry must be unique. If empty, all networks are allowed.
Excessively long lists should be avoided.

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

Must be at least 1 characters long

Hosts

Type: array of string Default: []

List of IP's/hostnames which are allowed to access the share. No quotes or spaces are allowed.
Each entry must be unique. If empty, all IP's/hostnames are allowed.
Excessively long lists should be avoided.

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

Must be at least 1 characters long

Ro

Type: boolean Default: false

Export the share as read only.

Maproot User

Default: null

Map root user client to a specified user.

Type: string
Type: null

Maproot Group

Default: null

Map root group client to a specified group.

Type: string
Type: null

Mapall User

Default: null

Map all client users to a specified user.

Type: string
Type: null

Mapall Group

Default: null

Map all client groups to a specified group.

Type: string
Type: null

Security

Type: array of enum (of string) Default: []

Specify the security schema.

No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "SYS"
  • "KRB5"
  • "KRB5I"
  • "KRB5P"

Enabled

Type: boolean Default: true

Enable or disable the share.

Locked


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

Returns:
- True: The share is in a locked dataset.
- False: The share is not in a locked dataset.
- None: Lock status is not available because path locking information was not requested.

Type: boolean
Type: null

Expose Snapshots

Type: boolean Default: false

Enterprise feature to enable access to the ZFS snapshot directory for the export.
Export path must be the root directory of a ZFS dataset.


*Required roles:* SHARING_NFS_READ