66
77### Classes
88
9- * [ ` java_ks::config ` ] ( #java_ksconfig ) : java_ks configuration
9+ * [ ` java_ks::config ` ] ( #java_ks--config ) : java_ks configuration
1010
1111### Resource types
1212
1313* [ ` java_ks ` ] ( #java_ks ) : Manages the entries in a java keystore, and uses composite namevars to accomplish the same alias spread across multiple target keystores.
1414
1515## Classes
1616
17- ### <a name =" java_ksconfig " ></a >` java_ks::config `
17+ ### <a name =" java_ks--config " ></a >` java_ks::config `
1818
1919java_ks configuration
2020
2121#### Parameters
2222
2323The following parameters are available in the ` java_ks::config ` class:
2424
25- * [ ` params ` ] ( #params )
25+ * [ ` params ` ] ( #-java_ks--config-- params )
2626
27- ##### <a name =" params " ></a >` params `
27+ ##### <a name =" -java_ks--config-- params" ></a >` params `
2828
2929Data type: ` Any `
3030
@@ -65,93 +65,93 @@ together with :password_file, but you must pass at least one of these parameters
6565
6666The following parameters are available in the ` java_ks ` type.
6767
68- * [ ` certificate ` ] ( #certificate )
69- * [ ` certificate_content ` ] ( #certificate_content )
70- * [ ` chain ` ] ( #chain )
71- * [ ` destkeypass ` ] ( #destkeypass )
72- * [ ` keytool_timeout ` ] ( #keytool_timeout )
73- * [ ` name ` ] ( #name )
74- * [ ` password_fail_reset ` ] ( #password_fail_reset )
75- * [ ` password_file ` ] ( #password_file )
76- * [ ` path ` ] ( #path )
77- * [ ` private_key ` ] ( #private_key )
78- * [ ` private_key_content ` ] ( #private_key_content )
79- * [ ` private_key_type ` ] ( #private_key_type )
80- * [ ` provider ` ] ( #provider )
81- * [ ` source_alias ` ] ( #source_alias )
82- * [ ` source_password ` ] ( #source_password )
83- * [ ` storetype ` ] ( #storetype )
84- * [ ` target ` ] ( #target )
85- * [ ` trustcacerts ` ] ( #trustcacerts )
86-
87- ##### <a name =" certificate " ></a >` certificate `
68+ * [ ` certificate ` ] ( #-java_ks-- certificate )
69+ * [ ` certificate_content ` ] ( #-java_ks-- certificate_content )
70+ * [ ` chain ` ] ( #-java_ks-- chain )
71+ * [ ` destkeypass ` ] ( #-java_ks-- destkeypass )
72+ * [ ` keytool_timeout ` ] ( #-java_ks-- keytool_timeout )
73+ * [ ` name ` ] ( #-java_ks-- name )
74+ * [ ` password_fail_reset ` ] ( #-java_ks-- password_fail_reset )
75+ * [ ` password_file ` ] ( #-java_ks-- password_file )
76+ * [ ` path ` ] ( #-java_ks-- path )
77+ * [ ` private_key ` ] ( #-java_ks-- private_key )
78+ * [ ` private_key_content ` ] ( #-java_ks-- private_key_content )
79+ * [ ` private_key_type ` ] ( #-java_ks-- private_key_type )
80+ * [ ` provider ` ] ( #-java_ks-- provider )
81+ * [ ` source_alias ` ] ( #-java_ks-- source_alias )
82+ * [ ` source_password ` ] ( #-java_ks-- source_password )
83+ * [ ` storetype ` ] ( #-java_ks-- storetype )
84+ * [ ` target ` ] ( #-java_ks-- target )
85+ * [ ` trustcacerts ` ] ( #-java_ks-- trustcacerts )
86+
87+ ##### <a name =" -java_ks-- certificate" ></a >` certificate `
8888
8989A file containing a server certificate, followed by zero or more intermediate certificate authorities.
9090All certificates will be placed in the keystore. This will autorequire the specified file.
9191
92- ##### <a name =" certificate_content " ></a >` certificate_content `
92+ ##### <a name =" -java_ks-- certificate_content" ></a >` certificate_content `
9393
9494A string containing a server certificate, followed by zero or more intermediate certificate authorities.
9595All certificates will be placed in the keystore.
9696
97- ##### <a name =" chain " ></a >` chain `
97+ ##### <a name =" -java_ks-- chain" ></a >` chain `
9898
9999The intermediate certificate authorities, if they are to be taken
100100from a file separate from the server certificate. This will autorequire the specified file.
101101
102- ##### <a name =" destkeypass " ></a >` destkeypass `
102+ ##### <a name =" -java_ks-- destkeypass" ></a >` destkeypass `
103103
104104The password used to protect the key in keystore.
105105
106- ##### <a name =" keytool_timeout " ></a >` keytool_timeout `
106+ ##### <a name =" -java_ks-- keytool_timeout" ></a >` keytool_timeout `
107107
108108Timeout for the keytool command in seconds.
109109
110110Default value: ` 120 `
111111
112- ##### <a name =" name " ></a >` name `
112+ ##### <a name =" -java_ks-- name" ></a >` name `
113113
114114namevar
115115
116116The alias that is used to identify the entry in the keystore. This will be
117117converted to lowercase.
118118
119- ##### <a name =" password_fail_reset " ></a >` password_fail_reset `
119+ ##### <a name =" -java_ks-- password_fail_reset" ></a >` password_fail_reset `
120120
121- Valid values: `` true `` , `` false ` `
121+ Valid values: ` true ` , ` false `
122122
123123If the supplied password does not succeed in unlocking the
124124keystore file, then delete the keystore file and create a new one.
125125Default: false.
126126
127- Default value: `` false ` `
127+ Default value: ` false `
128128
129- ##### <a name =" password_file " ></a >` password_file `
129+ ##### <a name =" -java_ks-- password_file" ></a >` password_file `
130130
131131The path to a file containing the password used to protect the
132132keystore. This cannot be used together with : password , but you must pass at least one of these parameters.
133133
134- ##### <a name =" path " ></a >` path `
134+ ##### <a name =" -java_ks-- path" ></a >` path `
135135
136136The search path used for command (keytool, openssl) execution.
137137Paths can be specified as an array or as a '
138138
139- ##### <a name =" private_key " ></a >` private_key `
139+ ##### <a name =" -java_ks-- private_key" ></a >` private_key `
140140
141141If you want an application to be a server and encrypt traffic,
142142you will need a private key. Private key entries in a keystore must be
143143accompanied by a signed certificate for the keytool provider. This parameter
144144allows you to specify the file name containing the private key. This will autorequire
145145the specified file.
146146
147- ##### <a name =" private_key_content " ></a >` private_key_content `
147+ ##### <a name =" -java_ks-- private_key_content" ></a >` private_key_content `
148148
149149If you want an application to be a server and encrypt traffic,
150150you will need a private key. Private key entries in a keystore must be
151151accompanied by a signed certificate for the keytool provider. This parameter allows you to specify the content
152152of the private key.
153153
154- ##### <a name =" private_key_type " ></a >` private_key_type `
154+ ##### <a name =" -java_ks-- private_key_type" ></a >` private_key_type `
155155
156156Valid values: ` rsa ` , ` dsa ` , ` ec `
157157
@@ -161,38 +161,38 @@ Valid options: <rsa>, <dsa>, <ec>. Defaults to <rsa>
161161
162162Default value: ` rsa `
163163
164- ##### <a name =" provider " ></a >` provider `
164+ ##### <a name =" -java_ks-- provider" ></a >` provider `
165165
166166The specific backend to use for this ` java_ks ` resource. You will seldom need to specify this --- Puppet will usually
167167discover the appropriate provider for your platform.
168168
169- ##### <a name =" source_alias " ></a >` source_alias `
169+ ##### <a name =" -java_ks-- source_alias" ></a >` source_alias `
170170
171171The source certificate alias
172172
173- ##### <a name =" source_password " ></a >` source_password `
173+ ##### <a name =" -java_ks-- source_password" ></a >` source_password `
174174
175175The source keystore password
176176
177- ##### <a name =" storetype " ></a >` storetype `
177+ ##### <a name =" -java_ks-- storetype" ></a >` storetype `
178178
179179Valid values: ` jceks ` , ` pkcs12 ` , ` jks `
180180
181181Optional storetype
182182Valid options: <jceks >, <pkcs12 >, <jks >
183183
184- ##### <a name =" target " ></a >` target `
184+ ##### <a name =" -java_ks-- target" ></a >` target `
185185
186186namevar
187187
188188Destination file for the keystore. This will autorequire the parent directory of the file.
189189
190- ##### <a name =" trustcacerts " ></a >` trustcacerts `
190+ ##### <a name =" -java_ks-- trustcacerts" ></a >` trustcacerts `
191191
192- Valid values: `` true `` , `` false ` `
192+ Valid values: ` true ` , ` false `
193193
194194Certificate authorities aren't by default trusted so if you are adding a CA you need to set this to true.
195195Defaults to : false .
196196
197- Default value: `` false ` `
197+ Default value: ` false `
198198
0 commit comments