Search the docs

Share Management

label-create

label-create [options]

Create a new label

Options

--help

Display this help and exit

--implied-labels

A comma-separated list of labels implied by this label. All labels in the implied label list must exist

--name

The name of the label. Label names are case-insensitive and must be unique (Required)


label-delete

label-delete [options]

Delete a label

Options

--help

Display this help and exit

--name

The name of the label to be deleted. When a label is deleted, its name is changed to reflect this fact and references to this label will use the modified name. (Required)


label-list

label-list [options]

List labels

Options

--help

Display this help and exit

--name

List a label by name


label-update

label-update [options]

Update a label

Options

--help

Display this help and exit

--implied-labels

A comma-separated list of labels implied by this label. Any existing implied labels are overridden. All labels in the implied label list must exist. Required unless any of the following is specified: --implied-labels-clear, --new-name

--implied-labels-clear

Remove the list of implied labels. Required unless any of the following is specified: --implied-labels, --new-name

--name

The name of the label to update (Required)

--new-name

A new name for the label. Required unless any of the following is specified: --implied-labels-clear, --implied-labels


objective-create

objective-create [options]

Create an objective

Options

--allowed-online-delay

Max time (in nanoseconds) for the file to be restored from offline Location back to online Location

--applied-objective

An objective and applicability statement Format: <objective-identifier>[,<applicability expression>] Example: durability-5-nines,IS_ONLINE May be repeated

--archive

Sets the archiving intent for data in a snapshot. Applicable only if selected by a Snapshot Condition. Possible values: NONE | ONSITE | OFFSITE.

--availability

Availability, specified as the number of nines (number between 0 and 20)

--confine-to

Confine to specific locations. Format: node|volume|object-volume|volume-group:{identifier}. The identifier must be either UUID or name

--description

The objective’s description

--do-not-move

Do not move

--durability

Durability, specified as the number of nines (number between 0 and 20)

--exclude-from

Exclude from specific locations. Format: node|volume|object-volume|volume-group:{identifier}. The identifier must be either UUID or name

--expression

Objective expression. Deprecated. Use --applied-objectives

--help

Display this help and exit

--max-read-response-time

Maximal read response time, in nanoseconds

--max-write-response-time

Maximal write response time, in nanoseconds

--min-read-iops

Minimum read IOPS

--min-read-throughput

Minimum read throughput, in bytes per second

--min-write-iops

Minimum write IOPS

--min-write-throughput

Minimum write throughput, in bytes per second

--name

The objective’s name (Required)

--optimize-for-capacity

Optimize for capacity

--place-on-list

Place on specific locations. Format: node|volume|object-volume|volume-group:{identifier}. The identifier must be either UUID or name

--priority

The objective's priority. Possible values: LOW | MEDIUM_LOW | MEDIUM | MEDIUM_HIGH | HIGH.


objective-delete

objective-delete [options]

Delete an objective

Options

--help

Display this help and exit

--id

The ID of the objective to delete. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the objective to delete. Required unless any of the following is specified: --name, --id

--name

The name of the objective to delete. Required unless any of the following is specified: --internal-id, --id


objective-export

objective-export [options]

Export objectives

Options

--help

Display this help and exit

--ids

The UUIDs of the objectives to export

--names

The names of the objectives to export

--target

The target path to export the objective


objective-import

objective-import [options]

Import objectives from file

Options

--help

Display this help and exit

--insecure

Connect with trust all certificate in case of https

--merge

Merge with existing or fail in case of collision

--names

The names of the objectives to import

--prefix

The prefix to be added to the names of the imported objectives

--source

The path of the file listing the objective to import (Required)


objective-list

objective-list [options]

List objectives

Options

--full

Print extra information for each element

--help

Display this help and exit

--id

The ID of the objective to list

--internal-id

The internal ID of the objective to list

--name

The name of the objective to list


objective-update

objective-update [options]

Update an objective

Options

--allowed-online-delay

Max time (in nanoseconds) for the file to be restored from offline Location back to online Location

--allowed-online-delay-clear

Clear the allowed online delay

--applied-objective-add

Adds a new applied objective Format: <objective-identifier>[,<applicability expression>] Example: durability-5-nines,IS_ONLINE May be repeated

--applied-objective-clear

Removes all existing applied objective.

--applied-objective-remove

Removes an existing applied objective. The value is the id of the applied objective being removed May be repeated

--applied-objective-update

Updates an existing applied objective with a different objective, or applicability expression, or both. The id must match that of the applied objective being updated Format: <id>,<objective-identifier>[,<applicability expression>] Example: 12,durability-5-nines,IS_ONLINE May be repeated

--archive

Sets the archiving intent for data in a snapshot. Applicable only if selected by a Snapshot Condition. Possible values: NONE | ONSITE | OFFSITE.

--archive-clear

Clear the archiving intent for data in a snapshot

--availability

Availability, specified as the number of nines (number between 0 and 20)

--availability-clear

Clear the availability

--confine-to

Confine to specific locations. Format: node|volume|object-volume|volume-group:{identifier}. The identifier must be either UUID or name

--confine-to-clear

Clear the confine to locations

--description

The objective’s description

--description-clear

Clear the objective’s description

--do-not-move

Do not move

--do-not-move-clear

Clear the do not move instruction

--durability

Durability, specified as the number of nines (number between 0 and 20)

--durability-clear

Clear the durability

--exclude-from

Exclude from specific locations. Format: node|volume|object-volume|volume-group:{identifier}. The identifier must be either UUID or name

--exclude-from-clear

Clear the exclude from locations

--expression

Objective expression

--help

Display this help and exit

--id

The ID of the objective to update. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the objective to update. Required unless any of the following is specified: --name, --id

--max-read-response-time

Maximal read response time, in nanoseconds

--max-read-response-time-clear

Clear the maximal read response time

--max-write-response-time

Maximal write response time, in nanoseconds

--max-write-response-time-clear

Clear the maximal write response time

--min-read-iops

Minimum read IOPS

--min-read-iops-clear

Clear the minimum read IOPS

--min-read-throughput

Minimum read throughput, in bytes per second

--min-read-throughput-clear

Clear the minimum read throughput

--min-write-iops

Minimum write IOPS

--min-write-iops-clear

Clear the minimum write IOPS

--min-write-throughput

Minimum write throughput, in bytes per second

--min-write-throughput-clear

Clear the minimum write throughput

--name

The name of the objective to update. Required unless any of the following is specified: --internal-id, --id

--new-name

New name.

--optimize-for-capacity

Optimize for capacity

--optimize-for-capacity-clear

Clear the optimize for capacity instruction

--place-on-list

Place on specific locations. Format: node|volume|object-volume|volume-group:{identifier}. The identifier must be either UUID or name

--place-on-list-clear

Clear the place on locations

--priority

The objective's priority. Possible values: LOW | MEDIUM_LOW | MEDIUM | MEDIUM_HIGH | HIGH.

--priority-clear

Reset the priority


privileged-delete

privileged-delete [options]

Delete a WORM protected file or empty directory. Cannot be used to delete non-WORM files or directories

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--help

Display this help and exit

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely

--path

The path of the file or empty directory to be deleted. The path is relative within the specified share and must start with / (Required)

--share-id

The ID of the share containing the entry to be deleted. Required unless any of the following is specified: --share-internal-id, --share-name

--share-internal-id

The internal id of the share containing the entry to be deleted. Required unless any of the following is specified: --share-id, --share-name

--share-name

The name of the share containing the entry to be deleted. Required unless any of the following is specified: --share-id, --share-internal-id


share-clone-create

share-clone-create [options]

Clone share snapshot

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--destination-path

Destination directory path for clone. The path must be relative to the share’s root directory (Required)

--help

Display this help and exit

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely

--overwrite-destination

Whether to overwrite the destination directory if it exists

--share-id

Share ID. Required unless "--share-name" is specified

--share-name

Share name. Required unless "--share-id" is specified

--snapshot-name

Name of snapshot to be cloned (Required)


share-create

share-create [options]

Create a share

Example
share-create --name share2 --path /share2 --export-option *,rw,no-root-squash

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--default-selinux-context

A default SELinux security context for the share in the form of <user>:<role>:<type>:<sensitivity>[:<categories>].

--default-selinux-context system_u:object_r:default_t:s0
--default-selinux-context system_u:object_r:default_t:s0:c0,c1
--description

A textual description of the share

--export-option

Export options for the share.
A 3, 4 or 5-tuple including <client specification>,ro|rw,[no-]root-squash[,insecure][,sec=<security options>].
<client specification> (an IP address, hostname, netgroup, network address, or subdomain)
'ro' or 'rw' (read-only or read-write)
'no-root-squash' or 'root-squash'
'insecure' (Optional. If not specified, secure is used.)
'sec=<security options>' colon-separated list of security options. Ex: sec=sys:krb5
Possible values: 'sys', 'krb5', 'krb5i', 'krb5p'
(Optional, if not specified, system default of 'sys' is used)
The --export-option param can be used multiple times. Export options are identified by client specification.

--export-option *,rw,no-root-squash
--export-option @netgroup,ro,root-squash,insecure
--export-option 192.168.1.0/255.255.255.0,rw,no-root-squash
--export-option 192.168.1.0/24,rw,no-root-squash
--export-option 2001:0db8::/32,rw,no-root-squash,sec=krb5
--export-option fe80:0:0:0:213:72ff:fe3c:21bf,rw,no-root-squash
--export-option example.com,rw,no-root-squash,insecure,sec=sys:krb5
--export-option *.example.co.uk,rw,no-root-squash
--export-option *.domain[1-3].example.com,rw,no-root-squash
--export-option *.domain?.example.com,rw,no-root-squash
--help

Display this help and exit

--name

The name the system uses to identify the share. This name should be unique across all shares. When creating an SMB share, this name serves as the SMB Share Name used when accessing the share via SMB. (Required)

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely

--objective

An objective to be set on the share. Each value may comprise an objective name and optionally a comma followed by an applicability statement. When no applicability statement is supplied, TRUE is assumed. May be repeated

--override-mem-check

Allow share creation even when it would exceed memory requirements.

--path

The share’s NFS export path (i.e. /share1). If omitted, the share’s name will be used.

--preferred-domain

Preferred domain in which users have accounts. This field is required for mapping users from another domain into this domain.

--referral-address

Referral server addresses for client redirection. Specify IPv4 addresses, IPv6 addresses, or hostnames where clients should be redirected. The --referral-address param can be used multiple times. Multiple addresses can be specified as comma-separated values.

--referral-address 192.168.1.100
--referral-address 2001:db8::1
--referral-address 192.168.1.100,192.168.1.101
--referral-address 192.168.1.100 --referral-address 192.168.1.101
--referral-path

The NFS export path of the referred-to share (i.e. /target/data).

--replication-latency-alert-threshold

Number of seconds of replication latency which will be tolerated before an alert is created

--size

Limit the share size (quota).

--size-warning-threshold

Threshold (1-99 percent) for share capacity usage, an event will be sent if this threshold is reached.

--smb-browsable-off

Prevent the share from being listed among available shares in net view and in "My Network Places" in Windows.

--unmapped-group

Default group name, if there is no mapping discovered into the preferred domain.

--unmapped-user

Default username, if there is no mapping discovered into the preferred domain.


share-delete

share-delete [options]

Delete a share

You can only delete a share with a confirmation prompt. By default, the share delete will not be executed for 24 hours. If you have a share snapshot schedule, share deletion is not allowed.

Deleting a share also deletes all data on the share. This is destructive and cannot be reversed.

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--delay

Postpone share space reclaim for period of time (for example 24h). Mutually exclusive with "--now"

--delete-path

Delete the share path directory when the share is purged. Directory must be empty in order to be deleted

--help

Display this help and exit

--id

The ID of the share to delete. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share to delete. Required unless any of the following is specified: --name, --id

--name

The name of the share to delete. Required unless any of the following is specified: --internal-id, --id

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely

--now

Share space will be reclaimed immediately. Mutually exclusive with "--delay"


share-list

share-list [options]

Display a list of all shares available in the system. Two types of lists can be displayed: a full list and a summary list (default)

Options

--full

Print extra information for each element

--help

Display this help and exit

--id

The ID of the share to list

--internal-id

The internal ID of the share to list

--name

The name of the share to list


share-mount

share-mount [options]

Mount a share

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--help

Display this help and exit

--id

The ID of the share to mount. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share to mount. Required unless any of the following is specified: --name, --id

--name

The name of the share to mount. Required unless any of the following is specified: --internal-id, --id

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely


share-move

share-move [options]

Move share to a different path

This command only changes the export map of the share while leaving the old path intact.

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--help

Display this help and exit

--id

The ID of the share to move. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share to move. Required unless any of the following is specified: --name, --id

--name

The name of the share to move. Required unless any of the following is specified: --internal-id, --id

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely

--path

Path to mount the share on (i.e. /share1). The / prefix must be specified. (Required)


share-objective-add

share-objective-add [options]

Apply an objective to a share (or at a path within the share)

Options

--applicability

A statement used to conditionally apply the objective. When no applicability statement is supplied, it defaults to TRUE

--help

Display this help and exit

--id

The ID of the share. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share. Required unless any of the following is specified: --name, --id

--name

The name of the share. Required unless any of the following is specified: --internal-id, --id

--objective

The objective name (Required)

--path

A path within the share to apply the objective to. When omitted, the objective is added to the share itself


share-objective-list

share-objective-list [options]

List the applied and active objectives for a share (or at a path within the share)

Options

--help

Display this help and exit

--id

The ID of the share. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share. Required unless any of the following is specified: --name, --id

--name

The name of the share. Required unless any of the following is specified: --internal-id, --id

--path

A path within the share to list the objectives for. When omitted, the share’s objectives are listed


share-objective-remove

share-objective-remove [options]

Remove an applied objective from a share (or from a path within the share) When used with an objective which is inherited & not applied locally, this will mask it by adding the objective locally with an applicability that negates the inherited applicability.

Options

--applicability

The applicability statement of the objective being removed. Defaults to TRUE

--help

Display this help and exit

--id

The ID of the share. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share. Required unless any of the following is specified: --name, --id

--name

The name of the share. Required unless any of the following is specified: --internal-id, --id

--objective

The objective name to be removed. (Required)

--path

A path within the share to remove the objective from. When omitted, the objective is removed from the share itself


share-objective-reset

share-objective-reset [options]

Resets the objectives applied to a share (or at a path within the share) back to their defaults. For a share, this will result in the same applied objectives as those that are applied to new shares. For a path, this will result in all locally-applied objectives being removed

Options

--help

Display this help and exit

--id

The ID of the share. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share. Required unless any of the following is specified: --name, --id

--name

The name of the share. Required unless any of the following is specified: --internal-id, --id

--path

A path within the share to reset the objectives on. When omitted, the share objectives arereset to default


share-offline

share-offline [options]

Take a share to the offline state

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--help

Display this help and exit

--id

The ID of the share to take offline. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share to take offline. Required unless any of the following is specified: --name, --id

--name

The name of the share to take offline. Required unless any of the following is specified: --internal-id, --id

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely


share-online

share-online [options]

Bring a share to the online state

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--help

Display this help and exit

--id

The ID of the share to bring online. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share to bring online. Required unless any of the following is specified: --name, --id

--name

The name of the share to bring online. Required unless any of the following is specified: --internal-id, --id

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely


share-snapshot-create

share-snapshot-create [options]

Create share snapshot

Example
share-snapshot-create --share-name test --now

Options

--help

Display this help and exit

--now

Create immediate snapshot of the share. Required unless "--schedule-name" is specified

--retention-name

The name of the snapshot retention policy.

--schedule-name

Name for the schedule of periodic snapshots of the share. Required unless "--now" is specified

--share-id

Share ID. Required unless "--share-name" is specified

--share-name

Share name. Required unless "--share-id" is specified

--snapshot-name

Name to identify the snapshot. Applicable only with --now option


share-snapshot-delete

share-snapshot-delete [options]

Delete share snapshot

Options

--help

Display this help and exit

--share-id

Share ID. Required unless "--share-name" is specified

--share-name

Share name. Required unless "--share-id" is specified

--snapshot-name

Snapshot name. May include wild-card characters (for example 2001-01-01T12-00*) (Required)


share-snapshot-list

share-snapshot-list [options]

List snapshots for share

Options

--help

Display this help and exit

--share-id

Share ID. Required unless "--share-name" is specified

--share-name

Share name. Required unless "--share-id" is specified


share-snapshot-restore

share-snapshot-restore [options]

Restore files from a share snapshot (when used with --filename option) or a complete share snapshot.

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

This option can be used only when restoring the entire share.

--filename

Paths for files to be restored from the share snapshot. Multiple paths may be provided. A path must be relative to the share root directory. The filename in the path may include wild-card characters (for example, /dir/file*.txt)

--help

Display this help and exit

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely

--share-id

Share ID. Required unless "--share-name" is specified

--share-name

Share name. Required unless "--share-id" is specified

--snapshot-name

Share snapshot name (Required)


share-snapshot-schedule-list

share-snapshot-schedule-list [options]

List scheduled snapshots for share

Options

--help

Display this help and exit

--share-id

Share ID

--share-name

Share name


share-snapshot-update

share-snapshot-update [options]

Update share snapshot schedule

Options

--clear-snapshots

Delete all snapshots taken for the schedule. Can be provided along with remove-schedule

--help

Display this help and exit

--new-retention-name

The name of the snapshot retention policy. Required unless any of the following is specified: --remove-schedule, --remove-retention

--remove-retention

Remove retention from share snapshot schedule. Required unless any of the following is specified: --remove-schedule, --new-retention-name

--remove-schedule

Remove both schedule and retention from share snapshot. Required unless any of the following is specified: --new-retention-name, --remove-retention

--schedule-name

Name for the schedule of periodic snapshots of the share (Required)

--share-id

Share ID. Required unless "--share-name" is specified

--share-name

Share name. Required unless "--share-id" is specified


share-undelete

share-undelete [options]

Abort scheduled deletion a share

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--help

Display this help and exit

--id

The ID of the share to undelete. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share to undelete. Required unless any of the following is specified: --name, --id

--name

The name of the share to undelete. Required unless any of the following is specified: --internal-id, --id

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely


share-unmount

share-unmount [options]

Unmount a share

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--help

Display this help and exit

--id

The ID of the share to unmount. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share to unmount. Required unless any of the following is specified: --name, --id

--name

The name of the share to unmount. Required unless any of the following is specified: --internal-id, --id

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely


share-update

share-update [options]

Update a share

Options

--async

Causes the command to be executed asynchronously. A reference task identifier will be returned

--default-selinux-context

A default SELinux security context for the share in the form of <user>:<role>:<type>:<sensitivity>[:<categories>].

--default-selinux-context system_u:object_r:default_t:s0
--default-selinux-context system_u:object_r:default_t:s0:c0,c1
--default-selinux-context-clear

Clear the default SELinux security context

--description

A textual description of the share

--description-clear

Clears the share’s description

--export-option

Export options for the share.
A 3, 4 or 5-tuple including <client specification>,ro|rw,[no-]root-squash[,insecure][,sec=<security options>].
<client specification> (an IP address, hostname, netgroup, network address, or subdomain)
'ro' or 'rw' (read-only or read-write)
'no-root-squash' or 'root-squash'
'insecure' (Optional. If not specified, secure is used.)
'sec=<security options>' colon-separated list of security options. Ex: sec=sys:krb5
Possible values: 'sys', 'krb5', 'krb5i', 'krb5p'
(Optional, if not specified, system default of 'sys' is used)
The --export-option param can be used multiple times. Export options are identified by client specification.

--export-option *,rw,no-root-squash
--export-option @netgroup,ro,root-squash,insecure
--export-option 192.168.1.0/255.255.255.0,rw,no-root-squash
--export-option 192.168.1.0/24,rw,no-root-squash
--export-option 2001:0db8::/32,rw,no-root-squash,sec=krb5
--export-option fe80:0:0:0:213:72ff:fe3c:21bf,rw,no-root-squash
--export-option example.com,rw,no-root-squash,insecure,sec=sys:krb5
--export-option *.example.co.uk,rw,no-root-squash
--export-option *.domain[1-3].example.com,rw,no-root-squash
--export-option *.domain?.example.com,rw,no-root-squash
--export-option-add

Adds export option(s) to the share, without removing existing export options. Each value must contain <client specification>,ro|rw,[no-]root-squash[,insecure][,sec=<security options>].This param can be used multiple times

--export-option-clear

Resets the export options back to the default (*,rw,no-root-squash,sec=sys)

--export-option-delete

Removes existing export option(s) from the share. Provide only the client specification of the export option that should be removed; do not include access permissions, root-squash, or other options. This param can be used multiple times

--export-option-update

Modifies an export option that already exists on the share. Export options are uniquely identified by their client specification. Each value must contain <client specification>,ro|rw,[no-]root-squash[,insecure][,sec-<security options>]. This param can be used multiple times

--help

Display this help and exit

--id

The ID of the share to update. Required unless any of the following is specified: --internal-id, --name

--internal-id

The internal ID of the share to update. Required unless any of the following is specified: --name, --id

--name

The name of the share to update. Required unless any of the following is specified: --internal-id, --id

--new-name

A new name for the share

--no-timeout

When running a task-based command synchronously, monitor for task completion indefinitely

--preferred-domain

Preferred domain in which users have accounts. This field is required for mapping users from another domain into this domain

--preferred-domain-clear

Clear preferred domain attribute

--referral-address

Referral addresses (replaces existing list).

--referral-address-add

Add referral addresses to existing list.

--referral-address-remove

Remove referral addresses from existing list.

--referral-path

The NFS export path of the referred-to share (i.e. /target/data).

--replication-latency-alert-threshold

Number of seconds of replication latency which will be tolerated before an alert is created

--replication-latency-alert-threshold-clear

Clear replication latency alert threshold

--size

Limit the share size (quota).

--size-clear

Set no size limit on the share (no quota).

--size-warning-threshold

Threshold (1-99 percent) for share capacity usage, an event will be sent if this threshold is reached.

--smb-alias

Set SMB aliases. May be specified multiple times. Each alias has a name, a browsable flag, and a path within the share. An alias path must be created before creating the alias. Format: <alias-name>[,<browsable-[yes|no|on|off|true|false]>][,<alias-path>]. Path defaults to /. Browsable defaults to the share's browsable setting. This command will replace any existing aliases for the share.

--smb-alias-add

Similar to smb-alias but appends SMB aliases, leaving existing SMB aliases in place.

--smb-alias-clear

Clear SMB aliases

--smb-alias-delete

Delete specified SMB alias(es). May be specified multiple times. Format: <alias-name>

--smb-browsable-off

Prevent the share from being listed among available shares in net view and in "My Network Places" in Windows.

--smb-browsable-on

Allow the share to be listed among available shares in net view and in "My Network Places" in Windows.

--unmapped-group

Default group name, if there is no mapping discovered into the preferred domain

--unmapped-group-clear

Clear unmapped group attribute

--unmapped-user

Default username, if there is no mapping discovered into the preferred domain

--unmapped-user-clear

Clear unmapped user attribute