| blob | e5a985225390f1b1f07d439499c5ed9e683b3e0d |
1 '\" te
2 .\" Copyright 2015 Nexenta Systems, Inc. All rights reserved.
3 .\" Copyright (c) 2001 Sun Microsystems, Inc. All Rights Reserved
4 .\" Copyright 1989 AT&T
5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 .TH RPCINFO 8 "Feb 20, 2015"
9 .SH NAME
10 rpcinfo \- report RPC information
11 .SH SYNOPSIS
12 .LP
13 .nf
14 \fBrpcinfo\fR [\fB-T\fR \fItransport\fR] [\fB-m\fR | \fB-s\fR] [\fIhost\fR]
15 .fi
17 .LP
18 .nf
19 \fBrpcinfo\fR \fB-p\fR [\fIhost\fR]
20 .fi
22 .LP
23 .nf
24 \fBrpcinfo\fR \fB-T\fR \fItransport\fR \fIhost\fR \fIprognum\fR [\fIversnum\fR]
25 .fi
27 .LP
28 .nf
29 \fBrpcinfo\fR \fB-l\fR [\fB-T\fR \fItransport\fR] \fIhost\fR \fIprognum\fR \fIversnum\fR
30 .fi
32 .LP
33 .nf
34 \fBrpcinfo\fR [\fB-n\fR \fIportnum\fR] \fB-u\fR \fIhost\fR \fIprognum\fR [\fIversnum\fR]
35 .fi
37 .LP
38 .nf
39 \fBrpcinfo\fR [\fB-n\fR \fIportnum\fR] \fB-t\fR \fIhost\fR \fIprognum\fR [\fIversnum\fR]
40 .fi
42 .LP
43 .nf
44 \fBrpcinfo\fR \fB-a\fR \fIserv_address\fR \fB-T\fR \fItransport\fR \fIprognum\fR [\fIversnum\fR]
45 .fi
47 .LP
48 .nf
49 \fBrpcinfo\fR \fB-b\fR [\fB-T\fR \fItransport\fR] \fIprognum\fR \fIversnum\fR
50 .fi
52 .LP
53 .nf
54 \fBrpcinfo\fR \fB-d\fR [\fB-T\fR \fItransport\fR] \fIprognum\fR \fIversnum\fR
55 .fi
57 .SH DESCRIPTION
58 .LP
59 \fBrpcinfo\fR makes an \fBRPC\fR call to an \fBRPC\fR server and reports what
60 it finds.
61 .sp
62 .LP
63 In the first synopsis, \fBrpcinfo\fR lists all the registered \fBRPC\fR
64 services with \fBrpcbind\fR on \fIhost\fR. If \fIhost\fR is not specified, the
65 local host is the default. If \fB-s\fR is used, the information is displayed in
66 a concise format.
67 .sp
68 .LP
69 In the second synopsis, \fBrpcinfo\fR lists all the \fBRPC\fR services
70 registered with \fBrpcbind\fR, version 2. Note that the format of the
71 information is different in the first and the second synopsis. This is because
72 the second synopsis is an older protocol used to collect the information
73 displayed (version 2 of the \fBrpcbind\fR protocol).
74 .sp
75 .LP
76 The third synopsis makes an \fBRPC\fR call to procedure 0 of \fIprognum\fR and
77 \fIversnum\fR on the specified \fIhost\fR and reports whether a response was
78 received. \fItransport\fR is the transport which has to be used for contacting
79 the given service. The remote address of the service is obtained by making a
80 call to the remote \fBrpcbind\fR.
81 .sp
82 .LP
83 The \fIprognum\fR argument is a number that represents an \fBRPC\fR program
84 number (see \fBrpc\fR(4)).
85 .sp
86 .LP
87 If a \fIversnum\fR is specified, \fBrpcinfo\fR attempts to call that version of
88 the specified \fIprognum\fR. Otherwise, \fBrpcinfo\fR attempts to find all the
89 registered version numbers for the specified \fIprognum\fR by calling version
90 0, which is presumed not to exist; if it does exist, \fBrpcinfo\fR attempts to
91 obtain this information by calling an extremely high version number instead,
92 and attempts to call each registered version. Note that the version number is
93 required for \fB-b\fR and \fB-d\fR options.
94 .sp
95 .LP
96 The \fBEXAMPLES\fR section describe other ways of using \fBrpcinfo\fR.
97 .SH OPTIONS
98 .ne 2
99 .na
100 \fB\fB-T\fR\fI transport\fR\fR
101 .ad
102 .RS 19n
103 Specify the transport on which the service is required. If this option is not
104 specified, \fBrpcinfo\fR uses the transport specified in the \fBNETPATH\fR
105 environment variable, or if that is unset or \fINULL,\fR the transport in the
106 \fBnetconfig\fR(4) database is used. This is a generic option, and can be used
107 in conjunction with other options as shown in the \fBSYNOPSIS\fR.
108 .RE
110 .sp
111 .ne 2
112 .na
113 \fB\fB-a\fR \fIserv_address\fR\fR
114 .ad
115 .RS 19n
116 Use \fIserv_address\fR as the (universal) address for the service on
117 \fItransport\fR to \fBping\fR procedure 0 of the specified \fIprognum\fR and
118 report whether a response was received. The \fB-T\fR option is required with
119 the \fB-a\fR option. If \fIversnum\fR is not specified, \fBrpcinfo\fR tries to
120 ping all available version numbers for that program number. This option avoids
121 calls to remote \fBrpcbind\fR to find the address of the service. The
122 \fIserv_address\fR is specified in universal address format of the given
123 transport.
124 .RE
126 .sp
127 .ne 2
128 .na
129 \fB\fB-b\fR\fR
130 .ad
131 .RS 19n
132 Make an \fBRPC\fR broadcast to procedure 0 of the specified \fIprognum\fR and
133 \fIversnum\fR and report all hosts that respond. If \fItransport\fR is
134 specified, it broadcasts its request only on the specified transport. If
135 broadcasting is not supported by any transport, an error message is printed.
136 Use of broadcasting should be limited because of the potential for adverse
137 effect on other systems.
138 .RE
140 .sp
141 .ne 2
142 .na
143 \fB\fB-d\fR\fR
144 .ad
145 .RS 19n
146 Delete registration for the \fBRPC\fR service of the specified \fIprognum\fR
147 and \fIversnum\fR. If \fItransport\fR is specified, unregister the service on
148 only that transport, otherwise unregister the service on all the transports on
149 which it was registered. Only the owner of a service can delete a registration,
150 except the superuser, who can delete any service.
151 .RE
153 .sp
154 .ne 2
155 .na
156 \fB\fB-l\fR\fR
157 .ad
158 .RS 19n
159 Display a list of entries with a given \fIprognum\fR and \fIversnum\fR on the
160 specified \fIhost\fR. Entries are returned for all transports in the same
161 protocol family as that used to contact the remote \fBrpcbind\fR.
162 .RE
164 .sp
165 .ne 2
166 .na
167 \fB\fB-m\fR\fR
168 .ad
169 .RS 19n
170 Display a table of statistics of \fBrpcbind\fR operations on the given
171 \fIhost\fR. The table shows statistics for each version of \fBrpcbind\fR
172 (versions 2, 3 and 4), giving the number of times each procedure was requested
173 and successfully serviced, the number and type of remote call requests that
174 were made, and information about \fBRPC\fR address lookups that were handled.
175 This is useful for monitoring \fBRPC\fR activities on \fIhost\fR.
176 .RE
178 .sp
179 .ne 2
180 .na
181 \fB\fB-n\fR\fI portnum\fR\fR
182 .ad
183 .RS 19n
184 Use \fIportnum\fR as the port number for the \fB-t\fR and \fB-u\fR options
185 instead of the port number given by \fBrpcbind\fR. Use of this option avoids a
186 call to the remote \fBrpcbind\fR to find out the address of the service. This
187 option is made obsolete by the \fB-a\fR option.
188 .RE
190 .sp
191 .ne 2
192 .na
193 \fB\fB-p\fR\fR
194 .ad
195 .RS 19n
196 Probe \fBrpcbind\fR on \fIhost\fR using version 2 of the \fBrpcbind\fR
197 protocol, and display a list of all registered \fBRPC\fR programs. If
198 \fIhost\fR is not specified, it defaults to the local host. This option is not
199 useful for IPv6; use \fB-s\fR (see below) instead. Note that version 2 of the
200 \fBrpcbind\fR protocol was previously known as the portmapper protocol.
201 .RE
203 .sp
204 .ne 2
205 .na
206 \fB\fB-s\fR\fR
207 .ad
208 .RS 19n
209 Display a concise list of all registered \fBRPC\fR programs on \fIhost\fR. If
210 \fIhost\fR is not specified, it defaults to the local host.
211 .RE
213 .sp
214 .ne 2
215 .na
216 \fB\fB-t\fR\fR
217 .ad
218 .RS 19n
219 Make an \fBRPC\fR call to procedure 0 of \fIprognum\fR on the specified
220 \fIhost\fR using \fBTCP,\fR and report whether a response was received. This
221 option is made obsolete by the \fB-T\fR option as shown in the third synopsis.
222 .RE
224 .sp
225 .ne 2
226 .na
227 \fB\fB-u\fR\fR
228 .ad
229 .RS 19n
230 Make an \fBRPC\fR call to procedure 0 of \fIprognum\fR on the specified
231 \fIhost\fR using \fBUDP,\fR and report whether a response was received. This
232 option is made obsolete by the \fB-T\fR option as shown in the third synopsis.
233 .RE
235 .SH EXAMPLES
236 .LP
237 \fBExample 1 \fR\fBRPC\fR services.
238 .sp
239 .LP
240 To show all of the \fBRPC\fR services registered on the local machine use:
242 .sp
243 .in +2
244 .nf
245 \fBexample%\fR \fBrpcinfo\fR
246 .fi
247 .in -2
248 .sp
250 .sp
251 .LP
252 To show all of the \fBRPC\fR services registered with \fBrpcbind\fR on the
253 machine named \fBklaxon\fR use:
255 .sp
256 .in +2
257 .nf
258 \fBexample%\fR \fBrpcinfo\fR \fBklaxon\fR
259 .fi
260 .in -2
261 .sp
263 .sp
264 .LP
265 The information displayed by the above commands can be quite lengthy. Use the
266 \fB-s\fR option to display a more concise list:
268 .sp
269 .in +2
270 .nf
271 \fBexample%\fR \fBrpcinfo\fR \fB-s\fR \fBklaxon\fR
272 .fi
273 .in -2
274 .sp
276 .sp
278 .sp
279 .TS
280 l l l l l
281 l l l l l .
282 \fBprogram\fR \fBversion(s)\fR \fBnetid(s)\fR \fBservice\fR \fBowner\fR
283 \fB100000\fR \fB2,3,4\fR \fBtcp,udp,ticlts,ticots,ticotsord\fR \fBrpcbind\fR \fBsuperuser\fR
284 \fB100008\fR \fB1\fR \fBticotsord,ticots,ticlts,udp,tcp\fR \fBwalld\fR \fBsuperuser\fR
285 \fB100002\fR \fB2,1\fR \fBticotsord,ticots,ticlts,udp,tcp\fR \fBrusersd\fR \fBsuperuser\fR
286 \fB100001\fR \fB2,3,4\fR \fBticotsord,ticots,tcp,ticlts,udp\fR \fBrstatd\fR \fBsuperuser\fR
287 \fB100012\fR \fB1\fR \fBticotsord,ticots,ticlts,udp,tcp\fR \fBsprayd\fR \fBsuperuser\fR
288 \fB100007\fR \fB3\fR \fBticotsord,ticots,ticlts,udp,tcp\fR \fBypbind\fR \fBsuperuser\fR
289 \fB100029\fR \fB1\fR \fBticotsord,ticots,ticlts\fR \fBkeyserv\fR \fBsuperuser\fR
290 \fB100078\fR \fB4\fR \fBticotsord,ticots,ticlts\fR \fB-\fR \fBsuperuser\fR
291 \fB100024\fR \fB1\fR \fBticotsord,ticots,ticlts,udp,tcp\fR \fBstatus\fR \fBsuperuser\fR
292 \fB100021\fR \fB2,1\fR \fBticotsord,ticots,ticlts,udp,tcp\fR \fBnlockmgr\fR \fBsuperuser\fR
293 \fB100020\fR \fB1\fR \fBticotsord,ticots,ticlts,udp,tcp\fR \fBllockmgr\fR \fBsuperuser\fR
294 .TE
296 .sp
297 .LP
298 To show whether the \fBRPC\fR service with program number \fIprognum\fR and
299 version \fIversnum\fR is registered on the machine named \fBklaxon\fR for the
300 transport \fBTCP\fR use:
302 .sp
303 .in +2
304 .nf
305 \fBexample% rpcinfo \fR\fB-T\fR\fB tcp klaxon \fR\fIprognum versnum\fR
306 .fi
307 .in -2
308 .sp
310 .sp
311 .LP
312 To show all \fBRPC\fR services registered with version 2 of the \fBrpcbind\fR
313 protocol on the local machine use:
315 .sp
316 .in +2
317 .nf
318 \fBexample%\fR \fBrpcinfo\fR \fB-p\fR
319 .fi
320 .in -2
321 .sp
323 .sp
324 .LP
325 To delete the registration for version 1 of the \fBwalld\fR (program number
326 \fB100008\fR) service for all transports use:
328 .sp
329 .in +2
330 .nf
331 \fBexample# rpcinfo \fR\fB-d\fR\fB 100008 1\fR
332 .fi
333 .in -2
334 .sp
336 .sp
337 .LP
338 or
340 .sp
341 .in +2
342 .nf
343 \fBexample# rpcinfo \fR\fB-d\fR\fB walld 1\fR
344 .fi
345 .in -2
346 .sp
348 .SH SEE ALSO
349 .LP
350 \fBrpcbind\fR(8), \fBrpc\fR(3NSL), \fBnetconfig\fR(4), \fBrpc\fR(4),
351 \fBattributes\fR(5)