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