sharing.smb.share_precheck

Validate prerequisites for creating an SMB share before calling sharing.smb.create.

This is used by the UI to determine whether it should prompt to create SMB users when auto-creating a share. It verifies that the server is joined to a directory service or has at least one local SMB user, and, when name is supplied, that the share name is valid and not already in use.

Returns null on success. If any check fails, a JSON-RPC error response (code -32602, Invalid params) is returned describing the problem.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: smb_share_precheck

smb_share_precheck

Type: object

SharingSMBSharePrecheckArgs parameters.

 No Additional Properties

Name

Default: null

Name of the SMB share to validate (optional).

Type: string
Type: null

Result

Type: null

Returns null when the SMB share configuration passes validation checks.


Required roles: READONLY_ADMIN