Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

sharectl(8)

Name

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 and SMB. 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. An authorized user can use sharectl to set global values for NFS and SMB properties in the Solaris server management facility. See nfs(5) and smb(5).

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. If only client or server side support for the specified protocol is installed, then only client or server specific properties are displayed.

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

Set properties for the specified file sharing protocol. If only client or server side support for the specified protocol is installed, then only client or server specific properties can be set.

status [protocol]

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

showmount_info={full | none}

If the value of this property is none, the following rules apply:

  • A client can see only the shares that it is allowed to access.

  • A client cannot see access lists for the shares defined at server.

  • A client cannot see remote mounts from the server done by other clients.

If the value is full, these rules do not apply. The default value is full.

For example, to place the restrictions specified above for users of showmount(8), enter:

# sharectl set -p showmount_info=none nfs
% sharectl get -p showmount_info nfs
showmount_info=none

Examples

Example 1 Getting Properties

The following command gets the properties for the NFS protocol.

% sharectl get nfs
servers=1024
lockd_listen_backlog=32
lockd_servers=1024
lockd_retransmit_timeout=5
grace_period=90
server_versmin=2
server_versmax=4
client_versmin=2
client_versmax=4
server_delegation=on
server_numeric_stringid=true
nfsmapid_domain=oracle.com
max_connections=-1
protocol=ALL
listen_backlog=32
device=
resvport=off

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 Setting Property for SMB Server

The following command sets the value of the server_signing_required property for the SMB protocol.

% sharectl set -p server_signing_required=true smb
Example 5 Setting Property for SMB Client

The following command sets the value of the client_signing_required property for the SMB protocol.

% sharectl set -p client_signing_required=true smb
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(8).

# sharectl set trace=1 autofs
Example 7 Requiring Client to Use a Reserved Port for NFS Calls Shared With AUTH_SYS

The following command requires client to use a reserved port for NFS calls shared with AUTH_SYS.

# sharectl set -p resvport=on nfs

Exit Status

0

Successful completion.

non-zero

Command failed.

Files

/usr/include/libshare.h

Error codes used for exit status.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/core-os
Interface Stability
Committed

See Also

nfs(5), smb(5), user_attr(5), attributes(7), rbac(7), smf(7), standards(7), automount(8), automountd(8), lockd(8), mountd(8), nfsd(8), nfsmapid(8)