sharing.nfs.query

Sent on sharing.nfs changes.

Type: object

ADDED

SharingNFSAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

SharingNFSEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the NFS share.

path Required

Path

Type: string

Local path to be exported.

Must be at least 1 characters long

dataset Required

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 Required

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

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

Comment

Type: string Default: ""

User comment associated with share.

networks

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

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

Ro

Type: boolean Default: false

Export the share as read only.

maproot_user

Maproot User

Default: null

Map root user client to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

maproot_group

Maproot Group

Default: null

Map root group client to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_user

Mapall User

Default: null

Map all client users to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_group

Mapall Group

Default: null

Map all client groups to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

security

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

Enabled

Type: boolean Default: true

Enable or disable the share.

locked Required

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

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.

tier

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 Required

Tier Type

Type: enum (of string)

Storage performance tier for this share.

Must be one of:

• "REGULAR"
• "PERFORMANCE"

tier_job

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 Required

Tier Job Id

Type: string

Rewrite job identifier in dataset_name@job_uuid format.

Must be at least 1 characters long

dataset_name Required

Dataset Name

Type: string

ZFS dataset this job is operating on.

Must be at least 1 characters long

job_uuid Required

Job Uuid

Type: string

Unique identifier for this rewrite job.

Must be at least 1 characters long

status Required

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

Type: null

CHANGED

SharingNFSChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

SharingNFSEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the NFS share.

path Required

Path

Type: string

Local path to be exported.

Must be at least 1 characters long

dataset Required

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 Required

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

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

Comment

Type: string Default: ""

User comment associated with share.

networks

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

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

Ro

Type: boolean Default: false

Export the share as read only.

maproot_user

Maproot User

Default: null

Map root user client to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

maproot_group

Maproot Group

Default: null

Map root group client to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_user

Mapall User

Default: null

Map all client users to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_group

Mapall Group

Default: null

Map all client groups to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

security

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

Enabled

Type: boolean Default: true

Enable or disable the share.

locked Required

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

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.

tier

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 Required

Tier Type

Type: enum (of string)

Storage performance tier for this share.

Must be one of:

• "REGULAR"
• "PERFORMANCE"

tier_job

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 Required

Tier Job Id

Type: string

Rewrite job identifier in dataset_name@job_uuid format.

Must be at least 1 characters long

dataset_name Required

Dataset Name

Type: string

ZFS dataset this job is operating on.

Must be at least 1 characters long

job_uuid Required

Job Uuid

Type: string

Unique identifier for this rewrite job.

Must be at least 1 characters long

status Required

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

Type: null

REMOVED

SharingNFSRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: SHARING_NFS_READ