en-US/RDPCertificate.psm1-Help.xml
|
<?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:\></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:\></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:\></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> |