BetterTls-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-Tls</command:name> <command:verb>Disable</command:verb> <command:noun>Tls</command:noun> <maml:description> <maml:para>Disables one or more supplied TLS versions without affecting other settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disables one or more supplied TLS versions. Other versions will not be affected. For example, it `-Tls` is supplied and `Tls, Tls11` is currently configured, only `Tls` will be disabled.</maml:para> <maml:para>These TLS Settings are used by `Invoke-WebRequest` and `Invoke-RestMethod` when connecting to remote end points. These settings may also be used by other .NET APIs. Caution should be used when changing this as you may decrease your security settings or break access to previously working endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-Tls</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>By default, this cmdlet does not supply any output. Supplying `-PassThru` will cause the cmdlet to return the current TLS configuration.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Ssl3</maml:name> <maml:Description> <maml:para>If supplied, SSL 3.0 will be disabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.0 will be disabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls11</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.1 will be disabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls12</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.2 will be disabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>By default, this cmdlet does not supply any output. Supplying `-PassThru` will cause the cmdlet to return the current TLS configuration.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Ssl3</maml:name> <maml:Description> <maml:para>If supplied, SSL 3.0 will be disabled.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.0 will be disabled.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls11</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.1 will be disabled.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls12</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.2 will be disabled.</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="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</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="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Net.SecurityProtocolType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function calls `Set-Tls`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># Disable TLS 1.0 Disable-Tls -Tls</dev:code> <dev:remarks> <maml:para>The above example will disabled TLS 1.0.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/markekraus/BetterTls/blob/master/Docs/Disable-Tls.md</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Disable-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Enable-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Get-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Set-Tls.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-Tls</command:name> <command:verb>Enable</command:verb> <command:noun>Tls</command:noun> <maml:description> <maml:para>Enables one or more supplied TLS versions without affecting other settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Enables one or more supplied TLS versions. Other versions will not be affected. For example, it `-Tls` is supplied and `Tls11` is currently configured, the result will be `Tls, Tls11`.</maml:para> <maml:para>These TLS Settings are used by `Invoke-WebRequest` and `Invoke-RestMethod` when connecting to remote end points. These settings may also be used by other .NET APIs. Caution should be used when changing this as you may decrease your security settings or break access to previously working endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-Tls</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>By default, this cmdlet does not supply any output. Supplying `-PassThru` will cause the cmdlet to return the current TLS configuration.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Ssl3</maml:name> <maml:Description> <maml:para>If supplied, SSL 3.0 will be enabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.0 will be enabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls11</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.1 will be enabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls12</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.2 will be enabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>By default, this cmdlet does not supply any output. Supplying `-PassThru` will cause the cmdlet to return the current TLS configuration.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Ssl3</maml:name> <maml:Description> <maml:para>If supplied, SSL 3.0 will be enabled.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.0 will be enabled.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls11</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.1 will be enabled.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls12</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.2 will be enabled.</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="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</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="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Net.SecurityProtocolType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function calls `Set-Tls`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># Enable TLS 1.2 Disable-Tls -Tls12</dev:code> <dev:remarks> <maml:para>The above example will enable TLS 1.2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/markekraus/BetterTls/blob/master/Docs/Enable-Tls.md</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Enable-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Disable-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Get-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Set-Tls.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Tls</command:name> <command:verb>Get</command:verb> <command:noun>Tls</command:noun> <maml:description> <maml:para>Gets the current TLS configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves the current setting of `[System.Net.ServicePointManager]::SecurityProtocol`.</maml:para> <maml:para>These TLS Settings are used by `Invoke-WebRequest` and `Invoke-RestMethod` when connecting to remote end points. These settings may also be used by other .NET APIs. Caution should be used when changing this as you may decrease your security settings or break access to previously working endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Tls</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Net.SecurityProtocolType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-Tls</dev:code> <dev:remarks> <maml:para>Retrieve the current TLS settings.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/markekraus/BetterTls/blob/master/Docs/Get-Tls.md</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Get-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Disable-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Enable-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Set-Tls.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-Tls</command:name> <command:verb>Set</command:verb> <command:noun>Tls</command:noun> <maml:description> <maml:para>Sets the TLS settings with only those supplied.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the TLS settings with only those supplied. Settings not supplied will be disabled. For example, if `Ssl3, Tls` is currently set and `-Tls -Tls11 -Tls12` is supplied the result will be `Tls, Tls11, Tls12`.</maml:para> <maml:para>If the requested settings and the current settings are the same, no action will be taken.</maml:para> <maml:para>These TLS Settings are used by `Invoke-WebRequest` and `Invoke-RestMethod` when connecting to remote end points. These settings may also be used by other .NET APIs. Caution should be used when changing this as you may decrease your security settings or break access to previously working endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-Tls</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Caller</maml:name> <maml:Description> <maml:para>This parameter is for internal use only.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCmdlet</command:parameterValue> <dev:type> <maml:name>PSCmdlet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>By default, this cmdlet does not supply any output. Supplying `-PassThru` will cause the cmdlet to return the current TLS configuration.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityProtocol</maml:name> <maml:Description> <maml:para>A `System.Net.SecurityProtocolType` to overwrite the current TLS settings with.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">SystemDefault</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ssl3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tls</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tls11</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tls12</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SecurityProtocolType</command:parameterValue> <dev:type> <maml:name>SecurityProtocolType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-Tls</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Caller</maml:name> <maml:Description> <maml:para>This parameter is for internal use only.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCmdlet</command:parameterValue> <dev:type> <maml:name>PSCmdlet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>By default, this cmdlet does not supply any output. Supplying `-PassThru` will cause the cmdlet to return the current TLS configuration.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Ssl3</maml:name> <maml:Description> <maml:para>If supplied, SSL 3.0 will be enabled. If not supplied it will be disabled. If no other settings are supplied, only this setting will be applied. If other settings are supplied, this setting will be enabled along with the other settings.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.0 will be enabled. If not supplied it will be disabled. If no other settings are supplied, only this setting will be applied. If other settings are supplied, this setting will be enabled along with the other settings.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls11</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.1 will be enabled. If not supplied it will be disabled. If no other settings are supplied, only this setting will be applied. If other settings are supplied, this setting will be enabled along with the other settings.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls12</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.2 will be enabled. If not supplied it will be disabled. If no other settings are supplied, only this setting will be applied. If other settings are supplied, this setting will be enabled along with the other settings.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Caller</maml:name> <maml:Description> <maml:para>This parameter is for internal use only.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCmdlet</command:parameterValue> <dev:type> <maml:name>PSCmdlet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>By default, this cmdlet does not supply any output. Supplying `-PassThru` will cause the cmdlet to return the current TLS configuration.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityProtocol</maml:name> <maml:Description> <maml:para>A `System.Net.SecurityProtocolType` to overwrite the current TLS settings with.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecurityProtocolType</command:parameterValue> <dev:type> <maml:name>SecurityProtocolType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Ssl3</maml:name> <maml:Description> <maml:para>If supplied, SSL 3.0 will be enabled. If not supplied it will be disabled. If no other settings are supplied, only this setting will be applied. If other settings are supplied, this setting will be enabled along with the other settings.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.0 will be enabled. If not supplied it will be disabled. If no other settings are supplied, only this setting will be applied. If other settings are supplied, this setting will be enabled along with the other settings.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls11</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.1 will be enabled. If not supplied it will be disabled. If no other settings are supplied, only this setting will be applied. If other settings are supplied, this setting will be enabled along with the other settings.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tls12</maml:name> <maml:Description> <maml:para>If supplied, TLS 1.2 will be enabled. If not supplied it will be disabled. If no other settings are supplied, only this setting will be applied. If other settings are supplied, this setting will be enabled along with the other settings.</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="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</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="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Net.SecurityProtocolType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is called by `Enable-Tls` and `Disable-Tls`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-Tls -Tls -Tls11 -Tls12</dev:code> <dev:remarks> <maml:para>This example enables TLS 1.0, 1.1, and 1.2 and disables all other settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Setting = [System.Net.SecurityProtocolType]'Tls11, Tls12' Set-Tls -SecurityProtocol $Setting</dev:code> <dev:remarks> <maml:para>This example enables TLS 1.1, and 1.2 and disables all other settings.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/markekraus/BetterTls/blob/master/Docs/Set-Tls.md</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Set-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Disable-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Enable-Tls.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tls</maml:linkText> <maml:uri>https://github.com/markekraus/BetterTls/blob/master/Docs/Get-Tls.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |