sharing.webshare.query

Sent on sharing.webshare changes.

Type: object

ADDED

SharingWebshareAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

SharingWebshareEntry

Type: object

Webshare share entry on the TrueNAS server.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for this Webshare share.

name Required

Name

Type: string

Webshare share name.

Must be at least 1 characters long

path Required

Path

Type: string

Local server path to share by using the Webshare protocol. The path must start with /mnt/ and must be in a ZFS pool.

Must be at least 1 characters long

dataset Required

Dataset

Dataset name component of the path (e.g., 'tank/webshare'). 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

enabled

Enabled

Type: boolean Default: true

If unset, the Webshare share is not available.

is_home_base

Is Home Base

Type: boolean Default: false

If set, this share is used as the base path for user home directories. Only one share can have this enabled.

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

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

SharingWebshareChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

SharingWebshareEntry

Type: object

Webshare share entry on the TrueNAS server.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for this Webshare share.

name Required

Name

Type: string

Webshare share name.

Must be at least 1 characters long

path Required

Path

Type: string

Local server path to share by using the Webshare protocol. The path must start with /mnt/ and must be in a ZFS pool.

Must be at least 1 characters long

dataset Required

Dataset

Dataset name component of the path (e.g., 'tank/webshare'). 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

enabled

Enabled

Type: boolean Default: true

If unset, the Webshare share is not available.

is_home_base

Is Home Base

Type: boolean Default: false

If set, this share is used as the base path for user home directories. Only one share can have this enabled.

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

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

SharingWebshareRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: SHARING_WEBSHARE_READ