-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
GitHub Actions
committed
Dec 17, 2024
1 parent
66b39b2
commit 334970b
Showing
3 changed files
with
190 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
# Reference | ||
|
||
<!-- DO NOT EDIT: This document was generated by Puppet Strings --> | ||
|
||
## Table of Contents | ||
|
||
### Defined types | ||
|
||
* [`sslcertificate`](#sslcertificate): Author:: Paul Stack (mailto:[email protected]) Copyright:: Copyright (c) 2013 OpenTable Inc License:: MIT == Define: sslcertificate | ||
|
||
## Defined types | ||
|
||
### <a name="sslcertificate"></a>`sslcertificate` | ||
|
||
Author:: Paul Stack (mailto:[email protected]) | ||
Copyright:: Copyright (c) 2013 OpenTable Inc | ||
License:: MIT | ||
== Define: sslcertificate | ||
|
||
This defined type will install SSL Certs on windows | ||
|
||
=== Requirements/Dependencies | ||
|
||
Currently reequires the puppetlabs/stdlib module on the Puppet Forge in | ||
order to validate much of the the provided configuration. | ||
|
||
=== Parameters | ||
|
||
[*password*] | ||
The password for the given certificate | ||
By default is undef | ||
|
||
[*location*] | ||
The location to store intermediate certificates. | ||
Do not end the string with any forward or backslash. | ||
|
||
[*thumbprint*] | ||
The thumbprint used to verify the certificate | ||
|
||
[*store_dir*] | ||
The certificate store where the certificate will be installed to | ||
|
||
[*root_store*] | ||
The store location for the given certification store. Either LocalMachine or CurrentUser | ||
|
||
[*scripts_dir*] | ||
This parameter has been deprecated and is no longer used. | ||
|
||
[*exportable*] | ||
This parameter determines whether the certificate key is exportable or not. | ||
|
||
[*wildcard*] | ||
This parameter determines whether the certificate is a wildcard certificate or not. | ||
|
||
[*interstore*] | ||
This parameter determines whether the certificate is an intermediate certificate or not. | ||
|
||
|
||
=== Examples | ||
|
||
To install a certificate in the My directory of the LocalMachine root store: | ||
|
||
sslcertificate { "Install-PFX-Certificate" : | ||
name => 'mycert.pfx', | ||
password => 'password123', | ||
location => 'C:', | ||
thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B' | ||
} | ||
|
||
To install a certifcate in an alternative directory: | ||
|
||
sslcertificate { "Install-Intermediate-Certificate" : | ||
name => 'go_daddy_intermediate.p7b', | ||
location => 'C:', | ||
store_dir => 'CA', | ||
root_store => 'LocalMachine', | ||
thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B' | ||
} | ||
|
||
To install a certificate in the My directory of the LocalMachine root store | ||
and set the key as not exportable: | ||
|
||
sslcertificate { "Install-PFX-Certificate" : | ||
name => 'mycert.pfx', | ||
password => 'password123', | ||
location => 'C:', | ||
thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B', | ||
exportable => false | ||
} | ||
|
||
#### Parameters | ||
|
||
The following parameters are available in the `sslcertificate` defined type: | ||
|
||
* [`location`](#-sslcertificate--location) | ||
* [`thumbprint`](#-sslcertificate--thumbprint) | ||
* [`password`](#-sslcertificate--password) | ||
* [`root_store`](#-sslcertificate--root_store) | ||
* [`store_dir`](#-sslcertificate--store_dir) | ||
* [`scripts_dir`](#-sslcertificate--scripts_dir) | ||
* [`exportable`](#-sslcertificate--exportable) | ||
* [`wildcard`](#-sslcertificate--wildcard) | ||
* [`interstore`](#-sslcertificate--interstore) | ||
|
||
##### <a name="-sslcertificate--location"></a>`location` | ||
|
||
Data type: `String[1]` | ||
|
||
|
||
|
||
##### <a name="-sslcertificate--thumbprint"></a>`thumbprint` | ||
|
||
Data type: `String[1]` | ||
|
||
|
||
|
||
##### <a name="-sslcertificate--password"></a>`password` | ||
|
||
Data type: `Optional[String[1]]` | ||
|
||
|
||
|
||
Default value: `undef` | ||
|
||
##### <a name="-sslcertificate--root_store"></a>`root_store` | ||
|
||
Data type: `String[1]` | ||
|
||
|
||
|
||
Default value: `'LocalMachine'` | ||
|
||
##### <a name="-sslcertificate--store_dir"></a>`store_dir` | ||
|
||
Data type: `String[1]` | ||
|
||
|
||
|
||
Default value: `'My'` | ||
|
||
##### <a name="-sslcertificate--scripts_dir"></a>`scripts_dir` | ||
|
||
Data type: `Stdlib::Windowspath` | ||
|
||
|
||
|
||
Default value: `'C:\temp'` | ||
|
||
##### <a name="-sslcertificate--exportable"></a>`exportable` | ||
|
||
Data type: `Boolean` | ||
|
||
|
||
|
||
Default value: `true` | ||
|
||
##### <a name="-sslcertificate--wildcard"></a>`wildcard` | ||
|
||
Data type: `Boolean` | ||
|
||
|
||
|
||
Default value: `false` | ||
|
||
##### <a name="-sslcertificate--interstore"></a>`interstore` | ||
|
||
Data type: `Boolean` | ||
|
||
|
||
|
||
Default value: `false` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters