summaryrefslogtreecommitdiff
path: root/man/man8/puppet-certificate_revocation_list.8
blob: d37197aec90614efb17c398f2b1193b43a9f925b (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
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-certificate_revocation_list\fR \- Manage the list of revoked certificates\.
.
.SH "SYNOPSIS"
puppet certificate_revocation_list \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
.
.SH "DESCRIPTION"
This subcommand is primarily for retrieving the certificate revocation list from the CA\.
.
.SH "OPTIONS"
Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
\-\-mode MODE
The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
.
.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
.TP
\-\-verbose
Whether to log verbosely\.
.
.TP
\-\-debug
Whether to log debug information\.
.
.TP
\-\-extra HASH
A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
.
.TP
\-\-terminus TERMINUS
Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
.
.IP
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\.
.
.IP
The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\.
.
.SH "ACTIONS"
.
.TP
\fBdestroy\fR \- Delete the certificate revocation list\.
\fBSYNOPSIS\fR
.
.IP
puppet certificate_revocation_list destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Deletes the certificate revocation list\. This cannot be done over REST, but it is possible to delete the locally cached copy or the local CA\'s copy of the CRL\.
.
.IP
\fBRETURNS\fR
.
.IP
Nothing\.
.
.IP
\fBNOTES\fR
.
.IP
Although this action always deletes the CRL from the specified terminus, it requires a dummy argument; this is a known bug\.
.
.TP
\fBfind\fR \- Retrieve the certificate revocation list\.
\fBSYNOPSIS\fR
.
.IP
puppet certificate_revocation_list find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Retrieve the certificate revocation list\.
.
.IP
\fBRETURNS\fR
.
.IP
The certificate revocation list\. When used from the Ruby API: returns an OpenSSL::X509::CRL object\.
.
.IP
\fBNOTES\fR
.
.IP
Although this action always returns the CRL from the specified terminus, it requires a dummy argument; this is a known bug\.
.
.TP
\fBinfo\fR \- Print the default terminus class for this face\.
\fBSYNOPSIS\fR
.
.IP
puppet certificate_revocation_list info [\-\-terminus TERMINUS] [\-\-extra HASH]
.
.IP
\fBDESCRIPTION\fR
.
.IP
Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
.
.TP
\fBsave\fR \- Invalid for this subcommand\.
\fBSYNOPSIS\fR
.
.IP
puppet certificate_revocation_list save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this subcommand\.
.
.TP
\fBsearch\fR \- Invalid for this subcommand\.
\fBSYNOPSIS\fR
.
.IP
puppet certificate_revocation_list search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this subcommand\.
.
.SH "EXAMPLES"
\fBfind\fR
.
.P
Retrieve a copy of the puppet master\'s CRL:
.
.P
$ puppet certificate_revocation_list find crl \-\-terminus rest
.
.SH "NOTES"
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
.
.IP "\(bu" 4
\fBca\fR
.
.IP "\(bu" 4
\fBfile\fR
.
.IP "\(bu" 4
\fBrest\fR
.
.IP "" 0
.
.SH "COPYRIGHT AND LICENSE"
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING