| purpose |
string |
`purpose` applies common configuration presets depending on intended purpose. |
[optional] [default to 'DEFAULT_SHARE'] |
| path |
string |
`path` path to export over the SMB protocol. If server is clustered, then this path will be relative to the `cluster_volname`. |
[optional] |
| path_suffix |
string |
|
[optional] [default to ''] |
| home |
bool |
|
[optional] [default to false] |
| name |
string |
|
[optional] |
| comment |
string |
|
[optional] [default to ''] |
| ro |
bool |
`ro` when enabled, prohibits write access to the share. |
[optional] [default to false] |
| browsable |
bool |
|
[optional] [default to true] |
| timemachine |
bool |
`timemachine` when set, enables Time Machine backups for this share. |
[optional] [default to false] |
| timemachine_quota |
int |
|
[optional] [default to 0] |
| recyclebin |
bool |
|
[optional] [default to false] |
| guestok |
bool |
`guestok` when enabled, allows access to this share without a password. |
[optional] [default to false] |
| abe |
bool |
|
[optional] [default to false] |
| hostsallow |
mixed[] |
`hostsallow` is a list of hostnames / IP addresses which have access to this share. `hostsdeny` is a list of hostnames / IP addresses which are not allowed access to this share. If a handful of hostnames are to be only allowed access, `hostsdeny` can be passed "ALL" which means that it will deny access to ALL hostnames except for the ones which have been listed in `hostsallow`. |
[optional] |
| hostsdeny |
mixed[] |
`hostsdeny` is a list of hostnames / IP addresses which are not allowed access to this share. If a handful of hostnames are to be only allowed access, `hostsdeny` can be passed "ALL" which means that it will deny access to ALL hostnames except for the ones which have been listed in `hostsallow`. |
[optional] |
| aapl_name_mangling |
bool |
|
[optional] [default to false] |
| acl |
bool |
`acl` enables support for storing the SMB Security Descriptor as a Filesystem ACL. |
[optional] [default to true] |
| durablehandle |
bool |
|
[optional] [default to true] |
| shadowcopy |
bool |
`shadowcopy` enables support for the volume shadow copy service. |
[optional] [default to true] |
| streams |
bool |
`streams` enables support for storing alternate datastreams as filesystem extended attributes. |
[optional] [default to true] |
| fsrvp |
bool |
`fsrvp` enables support for the filesystem remote VSS protocol. This allows clients to create ZFS snapshots through RPC. |
[optional] [default to false] |
| auxsmbconf |
string |
|
[optional] [default to ''] |
| enabled |
bool |
|
[optional] [default to true] |
| cluster_volname |
string |
`path` path to export over the SMB protocol. If server is clustered, then this path will be relative to the `cluster_volname`. |
[optional] [default to ''] |
| afp |
bool |
|
[optional] [default to false] |