usr/src/man/man1m/auditstat.1m

   1 '\" te
   2 .\" Copyright (c) 2008, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\" See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH AUDITSTAT 1M "Jun 16, 2009"
   7 .SH NAME
   8 auditstat \- display kernel audit statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBauditstat\fR [\fB-c\fR \fIcount\fR] [\fB-h\fR \fInumlines\fR] [\fB-i\fR \fIinterval\fR] [\fB-n\fR]
  13      [\fB-T\fR u | d ] [\fB-v\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBauditstat\fR displays kernel audit statistics. The fields displayed are as
  20 follows:
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fBaud\fR\fR
  25 .ad
  26 .RS 8n
  27 The total number of audit records processed by the \fBaudit\fR(2) system call.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fBctl\fR\fR
  34 .ad
  35 .RS 8n
  36 This field is obsolete.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBdrop\fR\fR
  43 .ad
  44 .RS 8n
  45 The total number of audit records that have been dropped. Records are dropped
  46 according to the kernel audit policy. See \fBauditon\fR(2), \fBAUDIT_CNT\fR
  47 policy for details.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBenq\fR\fR
  54 .ad
  55 .RS 8n
  56 The total number of audit records put on the kernel audit queue.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBgen\fR\fR
  63 .ad
  64 .RS 8n
  65 The total number of audit records that have been constructed (not the number
  66 written).
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBkern\fR\fR
  73 .ad
  74 .RS 8n
  75 The total number of audit records produced by user processes (as a result of
  76 system calls).
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBmem\fR\fR
  83 .ad
  84 .RS 8n
  85 The total number of Kbytes of memory currently in use by the kernel audit
  86 module.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBnona\fR\fR
  93 .ad
  94 .RS 8n
  95 The total number of non-attributable audit records that have been constructed.
  96 These are audit records that are not attributable to any particular user.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBrblk\fR\fR
 103 .ad
 104 .RS 8n
 105 The total number of times that the audit queue has blocked waiting to process
 106 audit data.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBtot\fR\fR
 113 .ad
 114 .RS 8n
 115 The total number of Kbytes of audit data written to the audit trail.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBwblk\fR\fR
 122 .ad
 123 .RS 8n
 124 The total number of times that user processes blocked on the audit queue at the
 125 high water mark.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBwrtn\fR\fR
 132 .ad
 133 .RS 8n
 134 The total number of audit records written. The difference between \fBenq\fR and
 135 \fBwrtn\fR is the number of outstanding audit records on the audit queue that
 136 have not been written.
 137 .RE
 138
 139 .SH OPTIONS
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fB-c\fR \fIcount\fR\fR
 144 .ad
 145 .RS 15n
 146 Display the statistics a total of \fIcount\fR times. If \fIcount\fR is equal to
 147 zero, statistics are displayed indefinitely. A time interval must be specified.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fB-h\fR \fInumlines\fR\fR
 154 .ad
 155 .RS 15n
 156 Display a header for every \fInumlines\fR of statistics printed. The default is
 157 to display the header every 20 lines. If \fInumlines\fR is equal to zero, the
 158 header is never displayed.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fB-i\fR \fIinterval\fR\fR
 165 .ad
 166 .RS 15n
 167 Display the statistics every \fIinterval\fR where \fIinterval\fR is the number
 168 of seconds to sleep between each collection.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fB-n\fR\fR
 175 .ad
 176 .RS 15n
 177 Display the number of kernel audit events currently configured.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fB-T\fR \fBu\fR | \fBd\fR\fR
 184 .ad
 185 .RS 15n
 186 Display a time stamp.
 187 .sp
 188 Specify \fBu\fR for a printed representation of the internal representation of
 189 time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See
 190 \fBdate\fR(1).
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fB-v\fR\fR
 197 .ad
 198 .RS 15n
 199 Display the version number of the kernel audit module software.
 200 .RE
 201
 202 .SH EXIT STATUS
 203 .sp
 204 .LP
 205 \fBauditstat\fR returns \fB0\fR upon success and \fB1\fR upon failure.
 206 .SH SEE ALSO
 207 .sp
 208 .LP
 209 \fBauditconfig\fR(1M), \fBpraudit\fR(1M), \fBbsmconv\fR(1M), \fBaudit\fR(2),
 210 \fBauditon\fR(2), \fBattributes\fR(5)
 211 .SH NOTES
 212 .sp
 213 .LP
 214 The functionality described in this man page is available only if Solaris
 215 Auditing has been enabled. See \fBbsmconv\fR(1M) for more information.