en-US/RDPCertificate.psm1-Help.xml

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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
    <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38-->
    <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38-->
    <!--
        Module: RDPCertificate
        Version: 0.0
    -->
    <!--All Commands-->
    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
        <!--TAG: HASCOMMONPARAMETERS-->
        <!--Command-->
        <command:details>
            <command:name>Set-RDPCertificate</command:name>
            <maml:description>
                <maml:para>Binds a new or existing certificate to the Remote Desktop service.</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Set</command:verb>
            <command:noun>RDPCertificate</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>You either pick an existing, installed certificate on your local computer or generate a new certificate with
the native Windows 10 "New-SelfSignedCertificate" cmdlet (the module will try to download the "PowerShell PKI"
module from the PSGallery if the OS is less than Windows 10). Using this certificate's thumbprint, the cmdlet
binds the thumbprint to the service. Changes are immediate, and no reboots (or service restarts) are required.</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem parametersetname="ExistingCert" default="true">
                <!--NAME: ExistingCert-->
                <!--TAG: DEFAULT-->
                <maml:name>Set-RDPCertificate</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="sha1 , thumb , Thumbprint" dynamic="true">
                    <maml:name>SHA1Thumbprint</maml:name>
                    <maml:description>
                        <maml:para>Specifies the SHA1 Thumbprint of a dynamic set of installed certificates on the local pc's "Personal" Certificate Store.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
                    <dev:type>
                        <maml:name>String</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue></dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="CreateNewCert">
                <!--NAME: CreateNewCert-->
                <maml:name>Set-RDPCertificate</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="sha1 , thumb , Thumbprint" dynamic="true">
                    <maml:name>SHA1Thumbprint</maml:name>
                    <maml:description>
                        <maml:para>Specifies the SHA1 Thumbprint of a dynamic set of installed certificates on the local pc's "Personal" Certificate Store.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
                    <dev:type>
                        <maml:name>String</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue></dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>WithNewSelfSignedCertificate</maml:name>
                    <maml:description>
                        <maml:para>Specifies that the script will create a new self-signed certificate using either the built-in cmdlet or the PSPKI module.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
                    <dev:type>
                        <maml:name>SwitchParameter</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue>False</dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ValidUntil</maml:name>
                    <maml:description>
                        <maml:para>Specifies the "end" date the newly-created certificate will be good to. By default, the date will 2 years from the current date.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue>
                    <dev:type>
                        <maml:name>DateTime</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue>[datetime]::Now.AddYears(2)</dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>HashAlgorithm</maml:name>
                    <maml:description>
                        <maml:para>Specifies the hash algorithm the cmdlets will use to generate the certificate with. By default, it will use SHA-256. Valid values are "SHA256", "SHA384", and "SHA512".</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
                    <command:parameterValueGroup>
                        <command:parameterValue required="false" variableLength="false">SHA256</command:parameterValue>
                        <command:parameterValue required="false" variableLength="false">SHA384</command:parameterValue>
                        <command:parameterValue required="false" variableLength="false">SHA512</command:parameterValue>
                    </command:parameterValueGroup>
                    <dev:type>
                        <maml:name>String</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue>SHA256</dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>KeyLength</maml:name>
                    <maml:description>
                        <maml:para>Specifies the key length the cmdlets will generate. By default, an RSA 2048-bit key is created. Valid values are "2048", "4096", "8192", and "16384".</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
                    <command:parameterValueGroup>
                        <command:parameterValue required="false" variableLength="false">2048</command:parameterValue>
                        <command:parameterValue required="false" variableLength="false">4096</command:parameterValue>
                        <command:parameterValue required="false" variableLength="false">8192</command:parameterValue>
                        <command:parameterValue required="false" variableLength="false">16384</command:parameterValue>
                    </command:parameterValueGroup>
                    <dev:type>
                        <maml:name>Int32</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue>2048</dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="sha1 , thumb , Thumbprint" dynamic="true">
                <maml:name>SHA1Thumbprint</maml:name>
                <maml:description>
                    <maml:para>Specifies the SHA1 Thumbprint of a dynamic set of installed certificates on the local pc's "Personal" Certificate Store.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>WithNewSelfSignedCertificate</maml:name>
                <maml:description>
                    <maml:para>Specifies that the script will create a new self-signed certificate using either the built-in cmdlet or the PSPKI module.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
                <dev:type>
                    <maml:name>SwitchParameter</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue>False</dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>ValidUntil</maml:name>
                <maml:description>
                    <maml:para>Specifies the "end" date the newly-created certificate will be good to. By default, the date will 2 years from the current date.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue>
                <dev:type>
                    <maml:name>DateTime</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue>[datetime]::Now.AddYears(2)</dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>HashAlgorithm</maml:name>
                <maml:description>
                    <maml:para>Specifies the hash algorithm the cmdlets will use to generate the certificate with. By default, it will use SHA-256. Valid values are "SHA256", "SHA384", and "SHA512".</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
                <command:parameterValueGroup>
                    <command:parameterValue required="false" variableLength="false">SHA256</command:parameterValue>
                    <command:parameterValue required="false" variableLength="false">SHA384</command:parameterValue>
                    <command:parameterValue required="false" variableLength="false">SHA512</command:parameterValue>
                </command:parameterValueGroup>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue>SHA256</dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>KeyLength</maml:name>
                <maml:description>
                    <maml:para>Specifies the key length the cmdlets will generate. By default, an RSA 2048-bit key is created. Valid values are "2048", "4096", "8192", and "16384".</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
                <command:parameterValueGroup>
                    <command:parameterValue required="false" variableLength="false">2048</command:parameterValue>
                    <command:parameterValue required="false" variableLength="false">4096</command:parameterValue>
                    <command:parameterValue required="false" variableLength="false">8192</command:parameterValue>
                    <command:parameterValue required="false" variableLength="false">16384</command:parameterValue>
                </command:parameterValueGroup>
                <dev:type>
                    <maml:name>Int32</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue>2048</dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!--Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>System.Security.Cryptography.X509Certificates.X509Certificate2</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para />
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!--Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>None</maml:name>
                    <maml:uri />
                </dev:type>
                <maml:description>
                    <maml:para />
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>Set-RDPCertificate -SHA1Thumbprint XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</dev:code>
                <dev:remarks>
                    <maml:para></maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>*** Using a generated self-signed cert with the default values ***</dev:code>
                <dev:remarks>
                    <maml:para>Set-RDPCertificate -WithNewSelfSignedCertificate</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>Set-RDPCertificate -WithNewSelfSignedCertificate -ValidUntil $([datetime]::Now.AddYears(10)) -HashAlgorithm SHA356 -KeyLength 8192</dev:code>
                <dev:remarks>
                    <maml:para></maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
        <maml:relatedLinks>
            <!--Links-->
            <maml:navigationLink>
                <maml:linkText>Online version:</maml:linkText>
                <maml:uri>https://github.com/Crypt32/PSPKI</maml:uri>
            </maml:navigationLink>
        </maml:relatedLinks>
    </command:command>
    <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38-->
</helpItems>