sharectl

- configure and manage file sharing service

Synopsis

sharectl [-h]

sharectl status [-h] [protocol]

sharectl get [-h] [-p property]... protocol

sharectl set [-h] [-p property=value]... protocol

Description

The sharectl command operates on file-sharing protocols, such as NFS. The command sets the client and server operational properties, takes and restores configuration snapshots, and gets status of the protocol service.

The get and set subcommands (see below) require root privileges or that you assume the Primary Administrator role. A non–privileged user can change the Solaris SMB client's persistent settings when granted the SMBFS Management rights profile in the /etc/user_attr file. See user_attr(4) and rbac(5). An authorized user can use sharectl to set global values for Solaris SMB server properties in the Solaris server management facility. See smb(4).

Options

The following options are supported:

-h

Displays usage message.

-p property[=value]

Specifies a property. See “Subcommands,” below.

Subcommands

sharectl supports the subcommands described below. The form of a sharectl command is:

# sharectl subcommand [option]

get [-p property] protocol

Get the property values for the specified protocol. If no -p option is provided, get all the properties for the specified protocol.

set [-p property=value]... protocol

Set properties for the specified file sharing protocol.

status [protocol]

Display status of the specified protocol, or, if no protocol is specified, of all file-sharing protocols.

Examples

Example 1 Getting Properties

The following command gets the properties for the NFS protocol.

% sharectl get nfs
lockd_listen_backlog=32
lockd_servers=20
lockd_retransmit_timeout=5
grace_period=90
nfsmapid_domain=sun.com
servers=16
server_versmin=2
server_versmax=4
max_connections=-1

The following command gets the value of the grace_period property for the NFS protocol.

% sharectl get -p grace_period nfs
grace_period=90

Example 2 Setting a Property

Note in the preceding example that the minimum version of the server NFS protocol (server_versmin) is set to 2. The following command sets the minimum version number to version 3.

% sharectl set -p server_versmin=3 nfs

Example 3 Obtaining Status

The following command obtains the status of all file-sharing protocols on a system.

% sharectl status
nfs      enabled

Example 4 Configuring Global Settings

The following command shows how an authorized user can use sharectl commands to configure global settings for the ex.com environment in the service management facility (SMF). See nsmbrc(4) for a description of the example environment, ex.com. See smf(5) for a description of the SMF.

# sharectl set -p section=default -p workgroup=SALES \ -p timeout=5 smbfs
# sharectl set -p section=FSERVER -p addr=fserv.ex.com smbfs
# sharectl set -p section=RSERVER -p workgroup=REMGROUP \ -p addr=rserv.ex.com smbfs
# sharectl set -p section=RSERVER:george -p timeout=30 smbfs
# sharectl set -p section="SSERV:*:POKY" -p addr=sserv.ex.com \ -p timeout=25 smbfs

Example 5 Displaying Current Settings for SMBFS

The following command shows how an authorized user can use the sharectl get command to view the global settings for smbfs in the SMF. The values shown are those set by the previous example.

# sharectl get smbfs
[default]
workgroup=SALES
timeout=5
[FSERVER]
addr=fserv.ex.com
[RSERVER]
workgroup=REMGROUP
addr=rserv.ex.com
[RSERVER:george]
timeout=30
[SSERV:*:POKY]
addr=sserv.ex.com
timeout=25

Example 6 Setting Tracing of RPC Calls for autofs

The following command expands each RPC call to autofs and logs it to the location specified for that service in automountd(1M).

# sharectl set trace=1 autofs

Exit Status

0

Successful completion.

non-zero

Command failed.

Files

/usr/include/libshare.h

Error codes used for exit status.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

automount(1M), automountd(1M), lockd(1M), mountd(1M), nfsd(1M), nfsmapid(1M), sharemgr(1M), nsmbrc(4), user_attr(4), attributes(5), rbac(5), smb(4), smf(5), standards(5)