puppet-certificate.8 in puppet-2.7.16

- old
+ new

@@ -1,15 +1,15 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CERTIFICATE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERTIFICATE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-certificate\fR \- Provide access to the CA for certificate management\.
 .
 .SH "SYNOPSIS"
-puppet certificate \fIaction\fR [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION]
+puppet certificate \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR
 .
 .SH "DESCRIPTION"
 This subcommand interacts with a local or remote Puppet certificate authority\. Currently, its behavior is not a full superset of \fBpuppet cert\fR; specifically, it is unable to mimic puppet cert\'s "clean" option, and its "generate" action submits a CSR rather than creating a signed certificate\.
 .
 .SH "OPTIONS"
@@ -40,10 +40,14 @@
 .
 .IP
 This option is required\.
 .
 .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\.
@@ -56,11 +60,11 @@
 .TP
 \fBdestroy\fR \- Delete a certificate\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet certificate destroy [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR
+puppet certificate destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIhost\fR
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
@@ -75,11 +79,11 @@
 .TP
 \fBfind\fR \- Retrieve a certificate\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet certificate find [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR
+puppet certificate find [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIhost\fR
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
@@ -87,21 +91,21 @@
 .
 .IP
 \fBRETURNS\fR
 .
 .IP
-An x509 SSL certificate\. You will usually want to render this as a string (\-\-render\-as s)\.
+An x509 SSL certificate\.
 .
 .IP
 Note that this action has a side effect of caching a copy of the certificate in Puppet\'s \fBssldir\fR\.
 .
 .TP
 \fBgenerate\fR \- Generate a new certificate signing request\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet certificate generate [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR
+puppet certificate generate [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR [\-\-dns\-alt\-names NAMES] \fIhost\fR
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
@@ -109,21 +113,27 @@
 .
 .IP
 Puppet agent usually handles CSR submission automatically\. This action is primarily useful for requesting certificates for individual users and external applications\.
 .
 .IP
+\fBOPTIONS\fR
+.
+.IP
+\fI\-\-dns\-alt\-names NAMES\fR \- The comma\-separated list of alternative DNS names to use for the local host\. When the node generates a CSR for itself, these are added to the request as the desired \fBsubjectAltName\fR in the certificate: additional DNS labels that the certificate is also valid answering as\. This is generally required if you use a non\-hostname \fBcertname\fR, or if you want to use \fBpuppet kick\fR or \fBpuppet resource \-H\fR and the primary certname does not match the DNS name you use to communicate with the host\. This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\. It is rarely necessary for servers; it is usually helpful only if you need to have a pool of multiple load balanced masters, or for the same master to respond on two physically separate networks under different names\.
+.
+.IP
 \fBRETURNS\fR
 .
 .IP
 Nothing\.
 .
 .TP
 \fBinfo\fR \- Print the default terminus class for this face\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet certificate info [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION]
+puppet certificate info [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
@@ -132,11 +142,11 @@
 .TP
 \fBlist\fR \- List all certificate signing requests\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet certificate list [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION]
+puppet certificate list [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
@@ -151,11 +161,11 @@
 .TP
 \fBsave\fR \- Invalid for this subcommand\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet certificate save [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION]
+puppet certificate save [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIkey\fR
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
@@ -164,11 +174,11 @@
 .TP
 \fBsearch\fR \- Invalid for this subcommand\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet certificate search [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIquery\fR
+puppet certificate search [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIquery\fR
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
@@ -177,16 +187,22 @@
 .TP
 \fBsign\fR \- Sign a certificate signing request for HOST\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet certificate sign [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR
+puppet certificate sign [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR [\-\-[no\-]allow\-dns\-alt\-names] \fIhost\fR
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
 Sign a certificate signing request for HOST\.
+.
+.IP
+\fBOPTIONS\fR
+.
+.IP
+\fI\-\-[no\-]allow\-dns\-alt\-names\fR \- Whether or not to accept DNS alt names in the certificate request
 .
 .IP
 \fBRETURNS\fR
 .
 .IP