summaryrefslogtreecommitdiffstats
path: root/base/deploy/man/man8/pkidestroy.8
blob: a8200081f2f5dbcbcd3766935fe5d3d8d0381d48 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH pkidestroy 8 "December 5, 2012" "version 1.0" "PKI Instance Removal Utility" Ade Lee
.\" Please adjust this date whenever revising the man page.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for man page specific macros, see man(7)
.SH NAME
pkidestroy \- Removes a subsystem from an instance of Certificate Server.

.SH SYNOPSIS
pkidestroy -s <subsystem> -i <instance> [-h] [-v] [-p <prefix>]

.SH DESCRIPTION
Removes a subsystem from an instance of Certificate Server.  This utility removes any of the Java-based Certificate Server subsystems (CA, KRA, OCSP, and TKS).
.PP
.TP
\fBNote:\fP 
This utility is only used for Java-based subsystems. The Apache-based Certificate Server Apache-based subsystems (RA and TPS) are removed using \fBpkiremove\fP.
.PP
An instance can contain multiple subsystems, although it may contain at most one of each type of subsystem.  So, for example, an instance could contain CA and KRA subsystems,  but not two CA subsystems.  If \fBpkidestroy\fP is invoked on the last subsystem in the instance, then that instance is removed.  Typically, as subsystems need to contact the CA to update the security domain, the CA instance should be the last instance to be removed.

.SH OPTIONS
.TP
.B -s <subsystem>
Specifies the subsystem to be removed, where <subsystem> is CA, KRA, OCSP, or TKS.
.TP
.B -i <instance>
Specifies the name of the instance from which the subsystem should be removed.  The instance is located at /var/log/pki/<instance>.
.TP
.B -h, --help
Prints additional help information.
.TP
.B -v
Displays verbose information about the installation.  This flag can be provided multiple times to increase verbosity.  See
.B pkidestroy -h 
for details.

.SH BUGS
Report bugs to http://bugzilla.redhat.com.

.SH AUTHORS
Ade Lee <alee@redhat.com>.  \fBpkidestroy\fP was written by the Dogtag project.

.SH COPYRIGHT
Copyright (c) 2012 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.

.SH SEE ALSO
.BR pkispawn(8)