Skip to main content

Shares

Shares

A share exposes a folder inside a volume over SMB or NFS, so it can be mounted directly by Windows, Linux, or macOS clients as a network file share —— no block-level host mapping required. A volume needs a file system assigned to it before you can add a share to it (see the Filesystems settings on the volume), and SMB/NFS authentication for the share is handled by the NAS server the volume's file system is attached to.

You can create more than one share on the same volume, each pointing at a different path inside it, as long as no two shares on the same volume use the same path.

Creating a share

Every share needs a protocol (SMB or NFS), a path inside the volume (or the volume's root, if left blank), and —— for NFS shares —— an authentication mode. Optionally you can restrict which client subnets are allowed to connect, make an SMB share browsable, turn on a recycle bin for deleted files, or set a capacity quota for the share.

  • NFS authentication determines how strictly this specific share enforces Kerberos: based on the NAS server's own settings, optional (client decides), required, or required with encryption.
  • Allowed subnets restricts which client IP ranges can reach the share, in ip/mask form (e.g. 192.168.0.0/255.255.0.0). Use *, or leave it blank, to allow all clients.
  • Quota caps how much data can be written through this share; it requires quotas to already be enabled on the volume's file system, and the quota can't exceed the volume's own capacity.

Using the web interface

  1. Open Application Volumes > Volumes, select the volume, and choose Create Share.
  2. Under Share Selection, enter the new share's name.
  3. Under Protocol, Path and Allowed Subnets, choose SMB or NFS, set the path, and optionally restrict allowed subnets.
  4. If you chose NFS, under NFS Authentication Settings, pick the Kerberos authentication mode.
  5. Under Additional Options, set browsability (SMB), read-only access, recycle bin, and/or a quota capacity.
  6. Confirm to create the share.

Using the CLI

applications shares add
    --application=<name> --volume=<name> --share=<name> (--smb|--nfs) [--browsable]
    (--nfsKerberosAuthenticationBasedOnServerSettings | --nfsKerberosAuthenticationOptional | --nfsKerberosAuthenticationRequired | --nfsKerberosAuthenticationAndEncryptionRequired)
    [--path=<path>] [--allowedSubnets=<subnets...>] [--recycleBin] [--readonlyAccess] [--quotaCapacity=<capacity_allow_zero>] [--force]
Option Description
--application=<name> The name of the application the share will be created in.
--volume=<name> The name of the volume on which the share will be created.
--share=<name> The name that will be given to the share.
--smb Choose SMB protocol for the share.
--nfs Choose NFS protocol for the share.
--browsable SMB only. Allows clients to browse the share.
--nfsKerberosAuthenticationBasedOnServerSettings Kerberos authentication follows the NAS server's own settings.
--nfsKerberosAuthenticationOptional Kerberos authentication and encryption are optional, based on the client's mount settings.
--nfsKerberosAuthenticationRequired Kerberos authentication is required.
--nfsKerberosAuthenticationAndEncryptionRequired Kerberos authentication and encryption are both required.
--path=<path> A path inside the volume the share redirects to. Defaults to the volume's root folder.
--allowedSubnets=<subnets...> Restrict access to specific IP subnets, in ip/mask form (e.g. 192.168.0.0/255.255.0.0). Use * or omit to allow all IPs.
--recycleBin Support a recycle bin for deleted files.
--readonlyAccess Allow read-only access to the share.
--quotaCapacity=<capacity_allow_zero> Capacity size quota for this share (0 removes the quota). Requires quotas to be enabled on the volume's file system.
--force Not currently used by this command.

Examples

Create a basic SMB share at the root of a volume:

applications shares add --application sales --volume reports --share reports --smb --browsable

Create an NFS share on a specific path, requiring Kerberos:

applications shares add --application sales --volume reports --share nfs-reports --nfs --path exports/reports --nfsKerberosAuthenticationRequired

Create a read-only SMB share restricted to a single subnet, with a 500 GB quota:

applications shares add --application sales --volume reports --share readonly-reports --smb --readonlyAccess --allowedSubnets 192.168.10.0/255.255.255.0 --quotaCapacity 500GB

Editing a share

Everything you set when creating a share can be changed afterward, including its name and path.

Using the web interface

  1. Open Application Volumes > Volumes, select the volume, and open its Shares list.
  2. Select the share and choose Edit.
  3. Update the fields you need under Share Selection, Protocol, Path and Allowed Subnets, NFS Authentication Settings, or Additional Options.
  4. Confirm the change.

Using the CLI

applications shares edit
    --application=<name> --volume=<name> --share=<name>
    [--newName=<name> (--smb|--nfs) (--browsable|--notBrowsable)
    (--nfsKerberosAuthenticationBasedOnServerSettings | --nfsKerberosAuthenticationOptional | --nfsKerberosAuthenticationRequired | --nfsKerberosAuthenticationAndEncryptionRequired)
    --path=<path> --allowedSubnets=<subnets...> --readonlyAccess|--readwriteAccess --recycleBin|--noRecycleBin
    (--disableQuota|--quotaCapacity=<capacity_allow_zero>)] [--force]
Option Description
--application=<name> The name of the application the share resides in.
--volume=<name> The name of the volume the share resides in.
--share=<name> The share you would like to edit.
--newName=<name> The new name for the share.
--smb Choose SMB protocol for the share.
--nfs Choose NFS protocol for the share.
--browsable SMB only. Allows clients to browse the share.
--notBrowsable SMB only. Blocks clients from browsing the share.
--nfsKerberosAuthenticationBasedOnServerSettings Kerberos authentication follows the NAS server's own settings.
--nfsKerberosAuthenticationOptional Kerberos authentication and encryption are optional, based on the client's mount settings.
--nfsKerberosAuthenticationRequired Kerberos authentication is required.
--nfsKerberosAuthenticationAndEncryptionRequired Kerberos authentication and encryption are both required.
--path=<path> A path inside the volume the share redirects to. Defaults to the volume's root folder.
--allowedSubnets=<subnets...> Restrict access to specific IP subnets, in ip/mask form. Use * or omit to allow all IPs.
--readonlyAccess Set read-only access to the share.
--readwriteAccess Set read-write access to the share.
--recycleBin Enable recycle bin.
--noRecycleBin Disable recycle bin.
--disableQuota Disable size quota for this share.
--quotaCapacity=<capacity_allow_zero> Capacity size quota for this share. 0 removes the quota.
--force Not currently used by this command.

Examples

Rename a share:

applications shares edit --application sales --volume reports --share reports --newName sales-reports

Switch a share to read-only and disable its quota:

applications shares edit --application sales --volume reports --share sales-reports --readonlyAccess --disableQuota

Restrict a share to a new subnet:

applications shares edit --application sales --volume reports --share sales-reports --allowedSubnets 10.0.5.0/255.255.255.0

Deleting shares

You can delete more than one share at a time, as long as none of them are paired in a migration pairing (unpair it first). If a share is scanned by an AI policy, you'll be warned that deleting it also discards everything indexed from it.

Using the web interface

  1. Open Application Volumes > Volumes, select the volume, and open its Shares list.
  2. Select the share(s) to delete and choose Delete.
  3. Confirm the deletion.

Using the CLI

applications shares delete --application=<name> --volume=<name> --shares=<name...> [--force]
Option Description
--application=<name> The name of the application instance the share resides in.
--volume=<name> The name of the volume the share resides in.
--shares=<name...> The names of the shares to delete.
--force Skip the confirmation prompt.

Examples

Delete a single share:

applications shares delete --application sales --volume reports --shares sales-reports

Delete several shares at once without a confirmation prompt:

applications shares delete --application sales --volume reports --shares reports nfs-reports --force

Listing shares

Using the web interface

Open Application Volumes > Volumes, select a volume, and open its Shares list. Leave the filters empty to see every share across every volume.

Using the CLI

applications shares list [--application=<name> --volume=<name>]
Option Description
--application=<name> Filter by application name.
--volume=<name> Filter by volume name.

Examples

List every share in the system:

applications shares list

List shares for a specific volume:

applications shares list --application sales --volume reports

See also: Volumes ·· NAS Servers