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

   1 '\" te
   2 .\" Copyright (c) 2017 Peter Tribble
   3 .\" Copyright (c) 1993, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH AUDIT 1M "Mar 6, 2017"
   8 .SH NAME
   9 audit \- control the behavior of the audit daemon
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBaudit\fR \fB-n\fR | \fB-s\fR | \fB-t\fR | \fB-v\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .LP
  18 The \fBaudit\fR command is the system administrator's interface to maintaining
  19 the audit daemon \fBauditd\fR(1M). The audit daemon can be stopped, started, or
  20 notified to reread the configuration, stored in \fBsmf\fR(5) and managed using
  21 the \fBauditconfig\fR(1M) command.
  22 .SH OPTIONS
  23 .ne 2
  24 .na
  25 \fB\fB-n\fR\fR
  26 .ad
  27 .RS 11n
  28 Notify the audit daemon to close the current audit file and open a new audit
  29 file in the current audit directory.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fB-s\fR\fR
  36 .ad
  37 .RS 11n
  38 Validates the audit service configuration and, if correct, notify the audit
  39 daemon to reread the audit configuration. If the audit daemon is not running,
  40 the audit daemon is started.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fB-t\fR\fR
  47 .ad
  48 .RS 11n
  49 Direct the audit daemon to close the current audit trail file, disable
  50 auditing, and die. Use \fB-s\fR to restart auditing.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB-v\fR
  57 .ad
  58 .RS 11n
  59 Validate the audit service configuration. At least one plugin must be active;
  60 if that plugin is \fBaudit_binfile\fR then its \fBp_dir\fR attribute must
  61 contain at least one valid directory, and its \fBp_minfree\fR attribute must
  62 be between 0 and 100.
  63 .RE
  64
  65 .SH DIAGNOSTICS
  66 .LP
  67 The \fBaudit\fR command will exit with \fB0\fR upon success and a positive
  68 integer upon failure.
  69
  70 .SH ATTRIBUTES
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Stability       Evolving
  83 .TE
  84
  85 .SH SEE ALSO
  86 .LP
  87 \fBpraudit\fR(1M), \fBauditconfig\fR(1M), \fBaudit\fR(2), \fBsmf\fR(5),
  88 \fBattributes\fR(5)
  89 .SH NOTES
  90 .LP
  91 The \fB-v\fR option can be used in any zone, but the \fB-t\fR, \fB-s\fR, and
  92 \fB-n\fR options are valid only in local zones and, then, only if the
  93 \fBperzone\fR audit policy is set. See \fBauditd\fR(1M) and
  94 \fBauditconfig\fR(1M) for per-zone audit configuration.