sharemgr - configure and manage file sharing
sharemgr subcommand [options]
add-share [-nth] [-r resource-name] [-d "description text"]
-s sharepath group
create [-nvh] [-P proto [-p property=value]] group
delete [-nvh] [-P proto] [-f] group
disable [-nvh] [-a | group...]
enable [-nvh] [-a | group...]
list [-vh] [-P proto]
move-share [-nv] -s sharepath destination-group
remove-share [-fnvh] -s sharepath group
set [-nvh] -P proto [-p property=value]... [-S optionset]
[ -s sharepath] group
set-share [-nh] [-r resource] [-d "description text"]
-s sharepath group
show [-pvxh] [-P proto] [group]...
unset [-nvh] -P proto [-S optionset] [-p property]...
group
share [-F fstype] [-p] [-o optionlist] [-d description]
[ pathname [resourcename]]
unshare [-F fstype] [-p] [-o optionlist] sharepath
The
sharemgr command configures share groups and the shares contained
within them.
A group name must conform to service management facility (SMF) (see
smf(5)) service-naming conventions, thus is limited to starting with an
alphabetic character, with the rest of the name consisting only of
alphanumeric characters plus
- (hyphen) and
_ (underbar).
Subcommands that result in a configuration change support a dry-run option. When
dry-run (
-n) is specified, the syntax and validity of the command is
tested but the configuration is not actually updated.
For all subcommands, the
-h option lists usage and help information.
For subcommands with the verbose (
-v) option, additional information
will be provided. For example, in conjunction with the
-n option,
verbose mode will also indicate whether the current user has sufficient
permissions to accomplish the operation.
There are two groups that are created automatically. The
default group
always exists and covers legacy NFS shares only. The
zfs group will be
created when ZFS shares are enabled.
The options shown in the SYNOPSIS section are described in the context of each
subcommand. All subcommands except
list and
show require root
privileges or that you assume the Primary Administrator role.
With no subcommand entered, a
sharemgr command with the
-h option
displays a usage message for all subcommands.
The following subcommands follow
sharemgr on a command line. Commands
take the form:
% sharemgr <subcommand> [options]
create [-nvh] [-P proto [-p
property=
value]]
group
Create a new group with specified name.
If
-n is specified, the command checks only the validity of the command
and that the group does not already exist.
If no protocol is specified, all known protocols are enabled for the specified
group. If a protocol is specified, only that protocol is enabled. You can
specify properties for a specified protocol.
If
group exists, use of
-P adds the specified protocol to that
group.
As an example of the
create subcommand, the following command creates a
new group with the name
mygroup.
# sharemgr create mygroup
Because no protocol was specified in the preceding command, all defined
protocols will be enabled on the group.
] [-f]
group
Delete the specified group. If the group is not empty,
you can use the
-f option to force the deletion, which unshares and
removes all shares from the group before removing the group itself.
If you specify a protocol, rather than deleting the whole group, this subcommand
deletes the protocol from the group.
The
-n option can be used to test the syntax of the command.
As an example, the following command removes the group
mygroup from the
configuration if it is empty.
# sharemgr delete mygroup
The following command removes any existing shares prior to removing the group.
# sharemgr delete -f mygroup
Note the use of the force (
-f) option, above.
]
List the defined groups.
If a protocol is specified, list only those groups that have the specified
protocol defined.
If the verbose option is specified, the current state of the group and all
protocols enabled on the group are listed as well. For example:
# sharemgr list -v
mygroup enabled nfs
rdonlygrp disabled nfs
] [
group...]
Shows the contents of the specified group(s).
If the verbose option is specified, the resource name and description of each
share is displayed if they are defined. Otherwise, only the share paths are
displayed. Also, when temporary shares are listed, they are prefixed with an
asterisk (
*).
If the
-p option is specified, all options defined for the protocols of
the group are displayed, in addition to the display without options. If the
-P option is used, the output is limited to those groups that have the
specified protocol enabled. If the
-x option is specified, output is in
XML format and the
-p and
-v options are ignored, because all
information is included in the XML.
The following example illustrates the use of the
-p option.
# sharemgr show -p mygroup
default nfs=()
* /data/backup
mygroup nfs=(nosuid=true)
/export/home/home0
/export/home/home1
The following example illustrates the use of the
-v option.
# sharemgr show -v mygroup
mygroup
HOME0=/export/home/home0 "Home directory set 0"
HOME1=/export/home/home1 "Home directory set 1"
ZFS managed shares are handled in a way similar to the way NFS shares are
handled. These shares appear as subgroups within the parent group
zfs.
The subgroups are always prefixed with
zfs/ and use the ZFS dataset
name for the rest of the name. The mount point and any sub-mounts that inherit
sharing are shown as the shares of the subgroup. For example:
# sharemgr show -vp zfs
zfs nfs=()
zfs/ztest
/ztest
/ztest/backups
[-S
optionset] [-p
property=
value]* [-s
share path]
group
Set protocol-specific properties on the specified group.
The
-P option is required and must specify a valid protocol.
Optionsets are protocol-specific sets of properties that can be negotiated by
the protocol client. For NFS, optionsets are equivalent to security modes as
defined in
nfssec(5). If
-S optionset is specified, the
properties are applied to the selected optionset. Otherwise they are applied
to the general optionset.
Together,
-P and
-S select a specific view of the group's options
on which to work.
Property values are strings. A specified property is set to a new value if the
property already exists or is added to the protocol if it does not already
exist.
In the general case, at least one property must be set. If
-S is
specified, properties can be omitted and the specified optionset is enabled
for the protocol.
The
-s option allows setting properties on a per-share basis. While this
is supported, it should be limited to managing legacy shares and to the
occasional need for an override of a group-level property or placing an
additional property on one share within a group.
An example of this subcommand:
# sharemgr set -P nfs -p anon=1234 mygroup
The preceding command adds the property
anon=1234 to the
nfs view
of group
mygroup. If
mygroup has existing shares, they will all
be reshared with the new property value(s).
] [-p
property]* [-s
sharepath ]
group
Unset the specified properties for the protocol or for
the specified
optionset of the protocol.
In the general case, at least one property must be set. If
-S is
specified, properties can be omitted and the specified optionset is removed
from the protocol.
The
-s option allows removing a share-specific property.
An example of this subcommand:
# sharemgr unset -P nfs -p anon mygroup
The preceding command removes the
anon= property from the
nfs view
of group
mygroup. If
mygroup has existing shares, they will all
be reshared with the new property value(s).
] [-d
"
description text"] -s
sharepath group
Add a new share to the specified group.
The
-s option is mandatory and takes a full directory path.
If either or both of
-d and
-r are specified, they specify values
associated with the share.
-d provides a description string to document
the share and
-r provides a protocol-independent resource name.
Resource names are not used by NFS at this time but can be specified. These
names currently follow the same naming rules as group names.
The temporary option (
-t) results in the share being shared but not
stored in the configuration repository. This option is intended for shares
that should not survive a reboot or server restart, or for testing purposes.
Temporary shares are indicated in the
show subcommand output with an
asterisk (
*) preceding the share.
If
sharepath is a ZFS path and that path is added to the
zfs
group,
sharemgr creates a new ZFS subgroup; the new share is added to
that subgroup. Any ZFS sub-filesystems under the ZFS filesystem designated by
sharepath will inherit the shared status of
sharepath.
The effect of the
add-share subcommand on a ZFS dataset is determined by
the values of the
sharesmb and
sharenfs properties of that
dataset.
See
zfs(1M) for a description of the
sharesmb and
sharenfs
properties.
The following are examples of the
add-share subcommand.
# sharemgr add-share -s /export/home/home0 -d "home \
directory set 0" -r HOME0 mygroup
# sharemgr add-share -s /export/home/home1 -d "home \
directory set 1" -r HOME1 mygroup
The preceding commands add
/export/home/home0 and
/export/home/home1 to the group
mygroup. A descriptive comment
and a resource name are included.
Move the specified share from the group it is currently
in to the specified destination group. The
move-share subcommand does
not create a group. A specified group must exist for the command to succeed.
The following is an example of this subcommand.
# sharemgr move-share -s /export/home/home1 newgroup
Assuming
/export/home/home1 is in the group
mygroup, the preceding
command moves
/export/home/home1 to the group
newgroup and
unshares and then reshares the directory with the properties associated with
newgroup.
Remove the specified share from the specified group. The
force (
-f) option forces the share to be removed even if it is busy.
You must specify the full path for
sharepath. For group, use the subgroup
as displayed in the output of the
sharemgr show command. Note that if
there are subshares that were created by inheritance, these will be removed,
along with the parent shares.
] [-d
"
description text"] -s
sharepath group
Set or change the specified share's description and
resource values. One use of
set-share is to rename a resource. The
syntax for this use of the subcommand is:
# sharemgr set-share -r current_name=new_name -s sharepath group
... | -a]
Enable the specified group(s), or (with
-a) all
groups, and start sharing the contained shares. This state persists across
reboots.
An enabled group will be shared whenever the corresponding SMF service instance
is enabled.
sharemgr will start the SMF service instance if it is not
currently online.
... | -a]
Disable the specified group(s), or (with
-a) all
groups, and unshare the shares that they contain. This state persists across
reboots.
A disabled group will not be shared even if the corresponding SMF service
instance is online. This feature is useful when you do not want a group of
shares to be started at boot time.
] [
group... | -a]
Start the specified group, or (with
-a) all
groups. The
start subcommand is similar to
enable in that all
shares are started, but
start works only on groups that are enabled.
start is used by the SMF to start sharing at system boot.
A group will not start sharing if it is in the
sharemgr disabled
state. However, the corresponding SMF service instance will be started.
Note that the
start subcommand is similar to the
shareall(1M)
command in that it starts up only the configured shares. That is, the enabled
shares will start being shared, but the configuration state is left the same.
The command:
# sharemgr start -a
...is equivalent to:
# shareall
] [
group... | -a]
Stop the specified group, or (with
-a) all groups.
The
stop subcommand is similar to
disable in that all shares are
no longer shared, but it works only on groups that are enabled.
stop is
used by the SMF to stop sharing at system shutdown.
Note that the
stop subcommand is similar to the
unshareall(1M)
command in that all active shares are unshared, but the configuration is left
the same. That is, the shares are stopped but the service instances are left
enabled. The command:
# sharemgr stop -a
...is equivalent to:
# unshareall
] [-p] [-o
optionlist] [-d
description] [
pathname [
resourcename]]
Shares the specified path in the default share
group. This subcommand implements the share(1M) functionality. Shares
that are shared in this manner will be transient shares. Use of the -p
option causes the shares to be persistent.
unshare [-F fstype] [-p] [-o
optionlist]
sharepath
Unshares the specified share. This subcommand implements
the unshare(1M) functionality. By default, the unshare is
temporary. The -p option is provided to remove the share from the
configuration in a way that persists across reboots.
0
Successful completion.
98
Service is offline and cannot be enabled (start
only).
other non-zero
Command failed.
/usr/include/libshare.h
Error codes used for exit status.
See
attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE |
ATTRIBUTE VALUE |
|
| Interface Stability |
Committed |
idmap(1M),
sharectl(1M),
zfs(1M),
attributes(5),
nfssec(5),
shareacl(5),
sharenfs(5),
sharesmb(5),
smf(5),
standards(5)