sharing.webshare.update

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the Webshare share to update.
Parameter 2: data

data

Type: object

Updated Webshare share configuration data.

 No Additional Properties

Name

Type: string

Webshare share name.

Must be at least 1 characters long

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

Enabled

Type: boolean

If unset, the Webshare share is not available.

Is Home Base

Type: boolean

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

SharingWebshareEntry

Type: object

The updated Webshare share configuration.

 No Additional Properties

Id

Type: integer

Unique identifier for this Webshare share.

Name

Type: string

Webshare share name.

Must be at least 1 characters long

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

Enabled

Type: boolean Default: true

If unset, the Webshare share is not available.

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


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


Required roles: SHARING_WEBSHARE_WRITE