.nh
.TH pki-audit 1 "Jun 30, 2015" PKI "PKI Audit Management Commands"
.SH NAME
.PP
pki-audit - Command-line interface for managing PKI audit configuration.

.SH SYNOPSIS
.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-audit\fP
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-audit-show\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-audit-mod\fP \fB--action\fP \fIaction\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-audit-mod\fP \fB--input\fP \fIinput-file\fP [\fIcommand-options\fP]

.SH DESCRIPTION
.PP
The \fBpki-audit\fP commands provide command-line interfaces to manage audit configuration in the specified subsystem.
Currently the only supported subsystem is \fBtps\fP\&.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-audit\fP
.br
    This command is to list the available audit commands for the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-audit-show\fP [\fIcommand-options\fP]
.br
    This command is to show the audit configuration in the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-audit-mod\fP \fB--action\fP \fIaction\fP [\fIcommand-options\fP]
.br
    This command is to change the audit (enabled/disabled) status in the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-audit-mod\fP \fB--input\fP \fIinput-file\fP [\fIcommand-options\fP]
.br
    This command is to modify the audit configuration in the subsystem.

.SH OPTIONS
.PP
The CLI options are described in \fBpki(1)\fP\&.

.SH OPERATIONS
.PP
To view available audit commands, type \fBpki <subsystem>-audit\fP\&.
To view each command's usage, type \fBpki <subsystem>-audit-<command> --help\fP\&.

.PP
All audit commands must be executed with the subsystem's admin authentication
(the user must be in the Administrators group).
See also the Authentication section in \fBpki(1)\fP\&.

.SS Viewing audit configuration
.PP
To view the audit configuration in TPS execute the following command:

.PP
.RS

.nf
$ pki <TPS admin authentication> tps-audit-show

.fi
.RE

.PP
To download the audit configuration from TPS into a file execute the following command:

.PP
.RS

.nf
$ pki <TPS admin authentication> tps-audit-show --output <output file>

.fi
.RE

.SS Changing audit status
.PP
To enable/disable audit in TPS, execute the following command:

.PP
.RS

.nf
$ pki <TPS admin authentication> tps-audit-mod --action <action>

.fi
.RE

.PP
where action is enable or disable.

.SS Modifying audit configuration
.PP
To modify the audit configuration in TPS, download the current configuration
using the above \fBtps-audit-show\fP command, edit the file,
then execute the following command:

.PP
.RS

.nf
$ pki <TPS admin authentication> tps-audit-mod --input <input file>

.fi
.RE

.PP
Optionally, a --output \fIoutput-file\fP option may be specified
to download the effective configuration after the modification.

.SH SEE ALSO
.PP
\fBpki(1)\fP

.SH AUTHORS
.PP
Endi S. Dewata &lt;edewata@redhat.com&gt;\&.

.SH COPYRIGHT
.PP
Copyright (c) 2015 Red Hat, Inc.
This is licensed under the GNU General Public License, version 2 (GPLv2).
A copy of this license is available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.