usr/src/man/man3rpc/rstat.3rpc

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH RSTAT 3RPC "Dec 30, 1996"
   7 .SH NAME
   8 rstat, havedisk \- get performance data from remote kernel
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lrpcsvc\fR [ \fIlibrary\fR ... ]
  13 #include <rpc/rpc.h>
  14 #include <rpcsvc/rstat.h>
  15
  16 \fBenum clnt_stat\fR \fBrstat\fR(\fBchar *\fR\fIhost\fR, \fBstruct statstime *\fR\fIstatp\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBhavedisk\fR(\fBchar *\fR\fIhost\fR);
  22 .fi
  23
  24 .SH PROTOCOL
  25 .sp
  26 .LP
  27 \fB/usr/include/rpcsvc/rstat.x\fR
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 These routines require that the \fBrpc.rstatd\fR(1M) daemon be configured and
  32 available on the remote system indicated by \fIhost\fR. The \fBrstat()\fR
  33 protocol is used to gather statistics from remote kernel.  Statistics will be
  34 available on items such as paging, swapping, and cpu utilization.
  35 .sp
  36 .LP
  37 \fBrstat()\fR fills in the \fBstatstime\fR structure \fIstatp\fR for
  38 \fIhost\fR.  \fIstatp\fR must point to an allocated \fBstatstime\fR structure.
  39 \fBrstat()\fR returns \fBRPC_SUCCESS\fR if it was successful; otherwise a
  40 \fBenum clnt_stat\fR is returned which can be displayed using
  41 \fBclnt_perrno\fR(3NSL).
  42 .sp
  43 .LP
  44 \fBhavedisk()\fR returns \fB1\fR if \fIhost\fR has disk, \fB0\fR if it does
  45 not, and \fB\(mi1\fR if this cannot be determined.
  46 .sp
  47 .LP
  48 The following XDR routines are available in \fBlibrpcsvc\fR:
  49 .sp
  50 .in +2
  51 .nf
  52 xdr_statstime
  53 xdr_statsvar
  54 .fi
  55 .in -2
  56 .sp
  57
  58 .SH ATTRIBUTES
  59 .sp
  60 .LP
  61 See \fBattributes\fR(5) for descriptions of the following attributes:
  62 .sp
  63
  64 .sp
  65 .TS
  66 box;
  67 c | c
  68 l | l .
  69 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  70 _
  71 MT-Level        MT-Safe
  72 .TE
  73
  74 .SH SEE ALSO
  75 .sp
  76 .LP
  77 \fBrup\fR(1), \fBrpc.rstatd\fR(1M), \fBrpc_clnt_calls\fR(3NSL),
  78 \fBattributes\fR(5)