.nh
.TH pki-server-subsystem 8 "July 15, 2015" PKI "PKI Subsystem Commands"
.SH NAME
.PP
pki-server-subsystem - Command-line interface for managing PKI subsystems.

.SH SYNOPSIS
.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem\fP
.br
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-find\fP
.br
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-show\fP \fIsubsystem-ID\fP
.br
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-enable\fP \fIsubsystem-ID\fP
.br
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-disable\fP \fIsubsystem-ID\fP
.br
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-cert-find\fP \fIsubsystem-ID\fP
.br
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-cert-show\fP \fIsubsystem-ID\fP \fIcert-ID\fP
.br
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-cert-export\fP \fIsubsystem-ID\fP \fIcert-ID\fP
.br
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-cert-update\fP \fIsubsystem-ID\fP \fIcert-ID\fP

.SH DESCRIPTION
.PP
The \fBpki-server subsystem\fP commands provide command-line interfaces to manage PKI subsystems.
A PKI server instance consists of a single Apache Tomcat instance that contains one or more PKI subsystems.
Valid subsystem identifiers are \fBca\fP, \fBkra\fP, \fBtks\fP, \fBocsp\fP and \fBtps\fP\&.
No instance may have more than one of each type of subsystem.

.PP
\fBpki-server subsystem\fP commands perform operations on a specific subsystem within a PKI server instance.
Consequently, all \fBpki-server subsystem\fP commands require specification of the instance ID to completely identify the target subsystem.

.PP
Operations that are available include: listing subsystems in an instance;
showing details about a subsystem; and enabling and disabling subsystems.

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem\fP
.br
    This command is to list available subsystem commands.

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-find\fP
.br
    This command is to list subsystems within a specific instance.

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-show\fP \fIsubsystem-ID\fP
.br
    This command is to view the details about a particular subsystem.

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-enable\fP \fIsubsystem-ID\fP
.br
    This command is to enable a particular subsystem.
    Each subsystem consists of a web application within the Apache Tomcat instance.
    Enabling a subsystem means deploying the web application so that the application initializes
    and is accessible via the HTTP and HTTPS ports for the Apache Tomcat instance.

.PP
\fBNote:\fP Each subsystem runs a set of self-tests on startup.
If these self-tests fail, the subsystem will be disabled by undeploying the web application.
The deployment status (enabled/disabled) of the subsystem can be determined from the output of \fBpki-server subsystem-show\fP\&.
Once the underlying problem is fixed, the subsystem should be re-enabled using \fBpki-server subsystem-enable\fP\&.

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-disable\fP \fIsubsystem-ID\fP
.br
    This command is to disable a subsystem by undeploying the web application corresponding to the subsystem.
    The subsystem will no longer be accessible through the web interfaces.
    This is useful when specific subsystems need to be made inaccessible for maintenance
    as Apache Tomcat allows web applications to be deployed/undeployed while the instance is still running (hot deployment).

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-cert-find\fP \fIsubsystem-ID\fP
.br
    This command is to list system certificates in a particular subsystem.

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-cert-show\fP \fIsubsystem-ID\fP \fIcert-ID\fP
.br
    This command is to view the details about a system certificate in a particular subsystem.

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-cert-export\fP \fIsubsystem-ID\fP \fIcert-ID\fP
.br
    This command is to export a system certificate in a particular subsystem.

.PP
\fBpki-server\fP [\fICLI-options\fP] \fBsubsystem-cert-update\fP \fIsubsystem-ID\fP \fIcert-ID\fP
.br
    This command is to update a system certificate in a particular subsystem.

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

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

.SH AUTHORS
.PP
Ade Lee <alee@redhat.com>

.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.