Print this page
Marcel's code review fixes
Marcel's update to 7651
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/sharectl.1m
+++ new/usr/src/man/man1m/sharectl.1m
1 1 .\"
2 2 .\" The contents of this file are subject to the terms of the
3 3 .\" Common Development and Distribution License (the "License").
4 4 .\" You may not use this file except in compliance with the License.
5 5 .\"
6 6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
7 7 .\" or http://www.opensolaris.org/os/licensing.
8 8 .\" See the License for the specific language governing permissions
9 9 .\" and limitations under the License.
10 10 .\"
|
↓ open down ↓ |
10 lines elided |
↑ open up ↑ |
11 11 .\" When distributing Covered Code, include this CDDL HEADER in each
12 12 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
13 13 .\" If applicable, add the following below this CDDL HEADER, with the
14 14 .\" fields enclosed by brackets "[]" replaced with your own identifying
15 15 .\" information: Portions Copyright [yyyy] [name of copyright owner]
16 16 .\"
17 17 .\"
18 18 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
19 19 .\" Copyright 2016 Nexenta Systems, Inc.
20 20 .\"
21 -.Dd March 1, 2016
21 +.Dd December 16, 2016
22 22 .Dt SHARECTL 1M
23 23 .Os
24 24 .Sh NAME
25 25 .Nm sharectl
26 26 .Nd configure and manage file sharing services
27 27 .Sh SYNOPSIS
28 28 .Nm
29 29 .Ar subcommand
30 30 .Op Fl h
31 31 .Nm
32 32 .Cm delsect
33 33 .Ar section protocol
34 34 .Nm
35 35 .Cm get
36 36 .Oo Fl p Ar property Oc Ns ...
37 37 .Ar protocol
38 38 .Nm
39 39 .Cm set
40 40 .Bro Fl p Ar property Ns = Ns Ar value Brc Ns ...
41 41 .Ar protocol
42 42 .Nm
43 43 .Cm status
44 44 .Op Ar protocol
45 45 .Sh DESCRIPTION
46 46 The
47 47 .Nm
48 48 command operates on file sharing services. The command sets the client and
49 49 server operational properties, takes and restores configuration snapshots, and
50 50 gets status of the protocol service. Currently supported services are
51 51 .Xr autofs 4 ,
52 52 .Xr nfs 4 ,
53 53 .Xr smb 4
54 54 and smbfs.
55 55 .Pp
56 56 The
57 57 .Cm set
58 58 subcommand requires root privileges or that you assume the Primary Administrator
59 59 role.
60 60 .Pp
61 61 A non-privileged user can change the persistent settings when granted required
62 62 authorizations, see appropriate sharing protocol man page.
63 63 .Ss Options
64 64 The following options are supported where applicable:
65 65 .Bl -tag -width Ds
66 66 .It Fl h
67 67 Displays usage message. Supported for all subcommands.
68 68 .It Fl p Ar property Ns Op = Ns Ar value
69 69 Specifies a property. See
70 70 .Sx Subcommands ,
71 71 below.
72 72 .El
73 73 .Ss Subcommands
74 74 .Nm
75 75 supports the subcommands described below:
76 76 .Bl -tag -width Ds
77 77 .It Xo
78 78 .Nm
79 79 .Cm delsect
80 80 .Ar section protocol
81 81 .Xc
82 82 Delete configuration section for the specified protocol. Currently only protocol
83 83 that has configuration sections is
84 84 .Nm smbfs
85 85 .Po see
86 86 .Xr nsmbrc 4
87 87 and
88 88 .Sx EXAMPLES
89 89 .Pc .
90 90 .It Xo
91 91 .Nm
92 92 .Cm get
93 93 .Oo Fl p Ar property Oc Ns ...
94 94 .Ar protocol
95 95 .Xc
96 96 Get the property values for the specified protocol. If no
97 97 .Fl p
98 98 option is provided, get all the properties for the specified protocol. For NFS,
99 99 properties correspond to entries in the
100 100 .Pa /etc/default/nfs
101 101 file. See
102 102 .Xr nfs 4 .
103 103 .It Xo
104 104 .Nm
105 105 .Cm set
106 106 .Bro Fl p Ar property Ns = Ns Ar value Brc Ns ...
107 107 .Ar protocol
108 108 .Xc
109 109 Set properties for the specified file sharing protocol.
110 110 .It Xo
111 111 .Nm
112 112 .Cm status
113 113 .Op Ar protocol
114 114 .Xc
115 115 Display status of the specified protocol, or, if no protocol is specified, of
116 116 all file sharing protocols.
117 117 .El
118 118 .Sh FILES
119 119 .Bl -tag -width Ds
120 120 .It Pa /usr/include/libshare.h
121 121 Error codes used for exit status.
122 122 .El
123 123 .Sh EXIT STATUS
124 124 .Bl -tag -width Ds
125 125 .It Sy 0
126 126 Successful completion.
127 127 .It Sy non-zero
128 128 Command failed.
129 129 .El
130 130 .Sh EXAMPLES
131 131 .Bl -tag -width Ds
132 132 .It Sy Example 1 No Setting a Property
|
↓ open down ↓ |
101 lines elided |
↑ open up ↑ |
133 133 The following command sets the minimum version of the server NFS protocol to
134 134 version 3.
135 135 .Bd -literal
136 136 # sharectl -p server_versmin=3 nfs
137 137 .Ed
138 138 .It Sy Example 2 No Getting Properties
139 139 The following command gets the properties for the NFS protocol.
140 140 .Bd -literal
141 141 # sharectl get nfs
142 142 lockd_listen_backlog=32
143 -lockd_servers=20
143 +lockd_servers=256
144 144 lockd_retransmit_timeout=5
145 145 grace_period=90
146 146 nfsmapid_domain=sun.com
147 -servers=16
147 +servers=1024
148 148 server_versmin=2
149 149 server_versmax=4
150 150 max_connections=-1
151 151 .Ed
152 152 .Pp
153 153 The following command gets the value of the grace_period property for the NFS
154 154 protocol.
155 155 .Bd -literal
156 156 # sharectl get -p grace_period nfs
157 157 grace_period=90
158 158 .Ed
159 159 .It Sy Example 3 No Obtaining Status
160 160 The following command obtains the status of all file-sharing protocols on a
161 161 system.
162 162 .Bd -literal
163 163 # sharectl status
164 164 nfs enabled
165 165 .Ed
166 166 .It Sy Example 4 No Configuring Global Settings
167 167 The following command shows how an authorized user can use
168 168 .Nm
169 169 commands to configure global settings for the
170 170 .Pa ex.com
171 171 environment in the service management facility
172 172 .Pq SMF .
173 173 See
174 174 .Xr nsmbrc 4
175 175 for a description of the example environment,
176 176 .Pa ex.com .
177 177 See
178 178 .Xr smf 5
179 179 for a description of the SMF.
180 180 .Bd -literal
181 181 # sharectl set -p section=default -p workgroup=SALES \e
182 182 -p timeout=5 smbfs
183 183 # sharectl set -p section=FSERVER -p addr=fserv.ex.com smbfs
184 184 # sharectl set -p section=RSERVER -p workgroup=REMGROUP \e
185 185 -p addr=rserv.ex.com smbfs
186 186 # sharectl set -p section=RSERVER:george -p timeout=30 smbfs
187 187 # sharectl set -p section="SSERV:*:POKY" -p addr=sserv.ex.com \e
188 188 -p timeout=25 smbfs
189 189 .Ed
190 190 .It Sy Example 5 No Displaying Current Settings
191 191 The following command shows how an authorized user can use the
192 192 .Nm sharectl Cm get
193 193 command to view the global settings for
194 194 .Nm smbfs
195 195 in the SMF. The values shown are those set by the previous example.
196 196 .Bd -literal
197 197 # sharectl get smbfs
198 198 [default]
199 199 workgroup=SALES
200 200 timeout=5
201 201 [FSERVER]
202 202 addr=fserv.ex.com
203 203 [RSERVER]
204 204 workgroup=REMGROUP
205 205 addr=rserv.ex.com
206 206 [RSERVER:george]
207 207 timeout=30
208 208 [SSERV:*:POKY]
209 209 addr=sserv.ex.com
210 210 timeout=25
211 211 .Ed
212 212 .El
213 213 .Sh INTERFACE STABILITY
214 214 .Sy Committed
215 215 .Sh SEE ALSO
216 216 .Xr sharemgr 1M ,
217 217 .Xr autofs 4 ,
218 218 .Xr nfs 4 ,
219 219 .Xr nsmbrc 4 ,
220 220 .Xr smb 4 ,
221 221 .Xr user_attr 4 ,
222 222 .Xr attributes 5 ,
223 223 .Xr rbac 5 ,
224 224 .Xr smf 5 ,
225 225 .Xr standards 5
|
↓ open down ↓ |
68 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX