|
| 1 | +# Reference |
| 2 | + |
| 3 | +<!-- DO NOT EDIT: This document was generated by Puppet Strings --> |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | + |
| 7 | +### Defined types |
| 8 | + |
| 9 | +* [`sslcertificate`](#sslcertificate): Author:: Paul Stack ( mailto:[email protected]) Copyright:: Copyright (c) 2013 OpenTable Inc License:: MIT == Define: sslcertificate |
| 10 | + |
| 11 | +## Defined types |
| 12 | + |
| 13 | +### <a name="sslcertificate"></a>`sslcertificate` |
| 14 | + |
| 15 | +Author:: Paul Stack ( mailto:[email protected]) |
| 16 | +Copyright:: Copyright (c) 2013 OpenTable Inc |
| 17 | +License:: MIT |
| 18 | +== Define: sslcertificate |
| 19 | + |
| 20 | +This defined type will install SSL Certs on windows |
| 21 | + |
| 22 | +=== Requirements/Dependencies |
| 23 | + |
| 24 | +Currently reequires the puppetlabs/stdlib module on the Puppet Forge in |
| 25 | +order to validate much of the the provided configuration. |
| 26 | + |
| 27 | +=== Parameters |
| 28 | + |
| 29 | +[*password*] |
| 30 | +The password for the given certificate |
| 31 | +By default is undef |
| 32 | + |
| 33 | +[*location*] |
| 34 | +The location to store intermediate certificates. |
| 35 | +Do not end the string with any forward or backslash. |
| 36 | + |
| 37 | +[*thumbprint*] |
| 38 | +The thumbprint used to verify the certificate |
| 39 | + |
| 40 | +[*store_dir*] |
| 41 | +The certificate store where the certificate will be installed to |
| 42 | + |
| 43 | +[*root_store*] |
| 44 | +The store location for the given certification store. Either LocalMachine or CurrentUser |
| 45 | + |
| 46 | +[*scripts_dir*] |
| 47 | +This parameter has been deprecated and is no longer used. |
| 48 | + |
| 49 | +[*exportable*] |
| 50 | +This parameter determines whether the certificate key is exportable or not. |
| 51 | + |
| 52 | +[*wildcard*] |
| 53 | +This parameter determines whether the certificate is a wildcard certificate or not. |
| 54 | + |
| 55 | +[*interstore*] |
| 56 | +This parameter determines whether the certificate is an intermediate certificate or not. |
| 57 | + |
| 58 | + |
| 59 | +=== Examples |
| 60 | + |
| 61 | +To install a certificate in the My directory of the LocalMachine root store: |
| 62 | + |
| 63 | + sslcertificate { "Install-PFX-Certificate" : |
| 64 | + name => 'mycert.pfx', |
| 65 | + password => 'password123', |
| 66 | + location => 'C:', |
| 67 | + thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B' |
| 68 | + } |
| 69 | + |
| 70 | +To install a certifcate in an alternative directory: |
| 71 | + |
| 72 | + sslcertificate { "Install-Intermediate-Certificate" : |
| 73 | + name => 'go_daddy_intermediate.p7b', |
| 74 | + location => 'C:', |
| 75 | + store_dir => 'CA', |
| 76 | + root_store => 'LocalMachine', |
| 77 | + thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B' |
| 78 | + } |
| 79 | + |
| 80 | +To install a certificate in the My directory of the LocalMachine root store |
| 81 | +and set the key as not exportable: |
| 82 | + |
| 83 | + sslcertificate { "Install-PFX-Certificate" : |
| 84 | + name => 'mycert.pfx', |
| 85 | + password => 'password123', |
| 86 | + location => 'C:', |
| 87 | + thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B', |
| 88 | + exportable => false |
| 89 | + } |
| 90 | + |
| 91 | +#### Parameters |
| 92 | + |
| 93 | +The following parameters are available in the `sslcertificate` defined type: |
| 94 | + |
| 95 | +* [`location`](#-sslcertificate--location) |
| 96 | +* [`thumbprint`](#-sslcertificate--thumbprint) |
| 97 | +* [`password`](#-sslcertificate--password) |
| 98 | +* [`root_store`](#-sslcertificate--root_store) |
| 99 | +* [`store_dir`](#-sslcertificate--store_dir) |
| 100 | +* [`scripts_dir`](#-sslcertificate--scripts_dir) |
| 101 | +* [`exportable`](#-sslcertificate--exportable) |
| 102 | +* [`wildcard`](#-sslcertificate--wildcard) |
| 103 | +* [`interstore`](#-sslcertificate--interstore) |
| 104 | + |
| 105 | +##### <a name="-sslcertificate--location"></a>`location` |
| 106 | + |
| 107 | +Data type: `String[1]` |
| 108 | + |
| 109 | + |
| 110 | + |
| 111 | +##### <a name="-sslcertificate--thumbprint"></a>`thumbprint` |
| 112 | + |
| 113 | +Data type: `String[1]` |
| 114 | + |
| 115 | + |
| 116 | + |
| 117 | +##### <a name="-sslcertificate--password"></a>`password` |
| 118 | + |
| 119 | +Data type: `Optional[String[1]]` |
| 120 | + |
| 121 | + |
| 122 | + |
| 123 | +Default value: `undef` |
| 124 | + |
| 125 | +##### <a name="-sslcertificate--root_store"></a>`root_store` |
| 126 | + |
| 127 | +Data type: `String[1]` |
| 128 | + |
| 129 | + |
| 130 | + |
| 131 | +Default value: `'LocalMachine'` |
| 132 | + |
| 133 | +##### <a name="-sslcertificate--store_dir"></a>`store_dir` |
| 134 | + |
| 135 | +Data type: `String[1]` |
| 136 | + |
| 137 | + |
| 138 | + |
| 139 | +Default value: `'My'` |
| 140 | + |
| 141 | +##### <a name="-sslcertificate--scripts_dir"></a>`scripts_dir` |
| 142 | + |
| 143 | +Data type: `Stdlib::Windowspath` |
| 144 | + |
| 145 | + |
| 146 | + |
| 147 | +Default value: `'C:\temp'` |
| 148 | + |
| 149 | +##### <a name="-sslcertificate--exportable"></a>`exportable` |
| 150 | + |
| 151 | +Data type: `Boolean` |
| 152 | + |
| 153 | + |
| 154 | + |
| 155 | +Default value: `true` |
| 156 | + |
| 157 | +##### <a name="-sslcertificate--wildcard"></a>`wildcard` |
| 158 | + |
| 159 | +Data type: `Boolean` |
| 160 | + |
| 161 | + |
| 162 | + |
| 163 | +Default value: `false` |
| 164 | + |
| 165 | +##### <a name="-sslcertificate--interstore"></a>`interstore` |
| 166 | + |
| 167 | +Data type: `Boolean` |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | +Default value: `false` |
| 172 | + |
0 commit comments