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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
.\" 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 pki-server-instance 8 "July 15, 2015" "version 10.2" "PKI Instance Management Commands" Dogtag Team
.\" 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
pki-server-instance \- Command-Line Interface for managing Certificate System instances.
.SH SYNOPSIS
.nf
\fBpki-server [CLI options] instance\fR
\fBpki-server [CLI options] instance-cert\fR
\fBpki-server [CLI options] instance-cert-export\fR
\fBpki-server [CLI options] instance-find\fR
\fBpki-server [CLI options] instance-show\fR <instance ID>
\fBpki-server [CLI options] instance-start\fR <instance ID>
\fBpki-server [CLI options] instance-stop\fR <instance ID>
\fBpki-server [CLI options] instance-migrate\fR --tomcat <version> <instance ID>
\fBpki-server [CLI options] instance-nuxwdog-enable\fR <instance ID>
\fBpki-server [CLI options] instance-nuxwdog-disable\fR <instance ID>
\fBpki-server [CLI options] instance-externalcert-add\fR -i <instance ID>
--cert-file <path> --trust-args <args> --nickname <nickname> --token <token>
\fBpki-server [CLI options] instance-externalcert-del\fR -i <instance ID>
--nickname <nickname> --token <token>
.fi
.SH DESCRIPTION
.PP
The \fBpki-server instance\fR commands provide command-line interfaces to manage
Certificate Server (CS) instances. A Certificate Server instance consists of a
single Apache Tomcat instance that contains one or more CS subsystems.
.PP
Operations that are available include: listing and showing details about local
instances; starting and stopping instances; performing instance migrations; and
enabling or disabling password prompted instance startup using \fBnuxwdog\fR.
.PP
\fBpki-server [CLI options] instance\fR
.RS 4
This command is to list available instance commands.
.RE
.PP
\fBpki-server [CLI options] instance-cert\fR
.RS 4
This command is to list available instance certificate commands.
.RE
.PP
\fBpki-server [CLI options] instance-cert-export\fR
.RS 4
This command is to export system certificates and keys to a PKCS #12 file. The output
filename and either a password or a password file are required. If no nicknames
are specified, all the system certificates will be exported. Otherwise, it is
possible to extract individual certificates (with or without their keys and trust arguments),
and to append to an existing PKCS #12 file.
.RE
.PP
\fBpki-server [CLI options] instance-find\fR
.RS 4
This command is to list local CS instances.
.RE
.PP
\fBpki-server [CLI options] instance-show\fR <instance ID>
.RS 4
This command is to view a details about a particular instance.
.RE
.PP
\fBpki-server [CLI options] instance-start\fR <instance ID>
.RS 4
This command is to start a CS instance. Note that currently this command
cannot be used to start \fBnuxwdog\fR-enabled instances.
.RE
.PP
\fBpki-server [CLI options] instance-stop\fR <instance ID>
.RS 4
This command is to stop a CS instance. Note that currently this command
cannot be used to stop \fBnuxwdog\fR-enabled instances.
.RE
.PP
\fBpki-server [CLI options] instance-migrate\fR --tomcat <version> <instance_ID>
.RS 4
There are differences in configuration between Apache Tomcat 7 and Apache Tomcat
8. This command reconfigures a CS instance to match the specified Tomcat version.
This command can be used to migrate initially created under Tomcat 7 when
Tomcat is upgraded.. See \fBpki-server migrate\fR(8) for further details.
.RE
.PP
\fBpki-server [CLI options] instance-nuxwdog-enable\fR <instance ID>
.RS 4
This command is to convert a CS instance to start without access to a
password file, using the \fBnuxwdog\fR daemon. See \fBpki-server nuxwdog\fR(8)
for further details.
.RE
.PP
\fBpki-server [CLI options] instance-nuxwdog-disable\fR <instance ID>
.RS 4
This command is to convert a CS instance to start with access to a
password file, rather than using the \fBnuxwdog\fR daemon. See \fBpki-server nuxwdog\fR(8)
for further details.
.RE
.PP
\fBpki-server [CLI options] instance-externalcert-add\fR -i <instance ID>
--cert-file <path> --trust-args <args> --nickname <nickname> --token <token>
.RS 4
This command is to add a certificate to the certificate database for a CS instance.
The certificate will be kept track of in the configuration file \fBexternal_certs.conf\fP,
and will automatically be exported when the system certificates are exported. To
update a certificate, the old one needs to be removed first using the delete command below.
The trust arguments are those defined for NSS databases eg. "C,c,c". See \fBcertutil(1)\fP
for more details.
.RE
.PP
\fBpki-server [CLI options] instance-externalcert-del\fR -i <instance ID>
--nickname <nickname> --token <token>
.RS 4
This command is to remove a certificate from the certificate database for a CS instance.
.RE
.SH OPTIONS
The CLI options are described in \fBpki-server\fR(8).
.SH OPERATIONS
To view available instance management commands, type \fBpki-server instance\fP.
To view each command's usage, type \fB pki-server instance-<command> \-\-help\fP.
All pki-server commands must be executed as the system administrator.
.SH AUTHORS
Ade Lee <alee@redhat.com>
.SH COPYRIGHT
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.
|
