sharing.nfs.query¶

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

Each item of this array must be:

Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                "name",
                "=",
                "bob"
            ],
            [
                "name",
                "=",
                "larry"
            ]
        ]
    ]
]

Parameter 2: options

options

Type: object

Default:

{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

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.

Value must be greater or equal to 0

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.

Value must be greater or equal to 0 and lesser or equal to 10000

Force Sql Filters

Type: boolean Default: false

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

Result

Any of

Type: array of object
No Additional Items

Each item of this array must be:

SharingNFSEntry

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

Dataset

Dataset name component of the path (e.g., 'tank/share'). Null if path cannot be resolved.

Any of

Option 1
Option 2

Type: string

Type: null

Relative Path

Relative path component within the dataset (e.g., 'subdir/data'). Null if path cannot be resolved.

Any of

Option 1
Option 2

Type: string

Type: null

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.

Any of

Option 1
Option 2

Type: string

Type: null

Maproot Group

Default: null

Map root group client to a specified group.

Any of

Option 1
Option 2

Type: string

Type: null

Mapall User

Default: null

Map all client users to a specified user.

Any of

Option 1
Option 2

Type: string

Type: null

Mapall Group

Default: null

Map all client groups to a specified group.

Any of

Option 1
Option 2

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.

Any of

Option 1
Option 2

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.

Default: null

Storage tier in which the share's underlying dataset is located. This field is read-only; configure the dataset's tier via zfs.tier.dataset_set_tier.

NOTE: this is a licensed feature. Will be null if TrueNAS is unlicensed, if tiering is disabled, or if the pool has no SPECIAL vdev.

Any of

TierInfo
Option 2

TierInfo

Type: object
No Additional Properties

Tier Type

Type: enum (of string)

Storage performance tier for this share.

Must be one of:

"REGULAR"
"PERFORMANCE"

Default: null

Most recent rewrite job for this share's dataset, or null if no job history exists.

Any of

ZfsTierRewriteJobEntry
Option 2

ZfsTierRewriteJobEntry

Type: object
No Additional Properties

Tier Job Id

Type: string

Rewrite job identifier in dataset_name@job_uuid format.

Must be at least 1 characters long

Dataset Name

Type: string

ZFS dataset this job is operating on.

Must be at least 1 characters long

Job Uuid

Type: string

Unique identifier for this rewrite job.

Must be at least 1 characters long

Status

Type: enum (of string)

Current lifecycle state of the job.

COMPLETE - All files in the dataset have been processed.
RUNNING - Job is actively processing files.
QUEUED - Job is waiting for a free execution slot (see max_concurrent_jobs).
CANCELLED - Job was stopped via zfs_tier_job.cancel. Not resumable.
STOPPED - Job was RUNNING but its process is no longer active (e.g. daemon restart). This state is computed on read and is never written to persistent storage.
ERROR - Job halted due to an unrecoverable error. Use zfs_tier_job.recover to retry failed files.

Must be one of:

"COMPLETE"
"RUNNING"
"QUEUED"
"CANCELLED"
"STOPPED"
"ERROR"

Type: null

SharingNFSEntry

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

Dataset

Dataset name component of the path (e.g., 'tank/share'). Null if path cannot be resolved.

Any of

Option 1
Option 2

Type: string

Type: null

Relative Path

Relative path component within the dataset (e.g., 'subdir/data'). Null if path cannot be resolved.

Any of

Option 1
Option 2

Type: string

Type: null

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.

Any of

Option 1
Option 2

Type: string

Type: null

Maproot Group

Default: null

Map root group client to a specified group.

Any of

Option 1
Option 2

Type: string

Type: null

Mapall User

Default: null

Map all client users to a specified user.

Any of

Option 1
Option 2

Type: string

Type: null

Mapall Group

Default: null

Map all client groups to a specified group.

Any of

Option 1
Option 2

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.

Any of

Option 1
Option 2

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.

Default: null

Storage tier in which the share's underlying dataset is located. This field is read-only; configure the dataset's tier via zfs.tier.dataset_set_tier.

NOTE: this is a licensed feature. Will be null if TrueNAS is unlicensed, if tiering is disabled, or if the pool has no SPECIAL vdev.

Any of

Option 1
Option 2

Type: object

Type: null

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: integer

Required roles: SHARING_NFS_READ

Table Of Contents

Previous topic

Next topic

sharing.nfs.query¶

Call parameters

Tuple Validation

Parameter 1: filters

filters

Each item of this array must be:

Parameter 2: options

options

extra

Extra

order_by

Order By

Each item of this array must be:

select

Select

Each item of this array must be:

Any of

Each item of this array must be:

count

Count

get

Get

offset

Offset

limit

Limit

force_sql_filters

Force Sql Filters

Return value

Result

Any of

Each item of this array must be:

SharingNFSEntry

id Required

Id

path Required

Path

dataset Required

Dataset

Any of

relative_path Required

Relative Path

Any of

aliases

Aliases

Each item of this array must be:

comment

Comment

networks

Networks

Each item of this array must be:

hosts

Hosts

Each item of this array must be:

ro

Ro

maproot_user

Maproot User

Any of

maproot_group

Maproot Group

Any of

mapall_user

Mapall User

Any of

mapall_group

Mapall Group

Any of

security

Security

Each item of this array must be:

Must be one of:

enabled

Enabled

locked Required

Locked

Any of