HelpCache/PS_VpnServerIPsecConfiguration_v1.0.0.cdxml-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <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-VpnServerConfiguration</command:name><maml:description><maml:para>Gets VPN server properties. </maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>VpnServerConfiguration</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-VpnServerConfiguration cmdlet gets virtual private network (VPN) server properties. The cmdlet gets settings for a Routing and Remote Access service (RRAS) server for incoming server-to-server protocol (S2S protocol) VPN interfaces. You can restrict the type of tunnel to view by specifying the TunnelType parameter.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-VpnServerConfiguration</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>TunnelType</maml:name><maml:description><maml:para>Specifies a tunnel type. If you specify a value for this parameter, the cmdlet gets properties only for tunnels of that type. The acceptable values for this parameter are: -- PPTP. Point-to-Point Tunneling Protocol. -- L2TP. Layer Two Tunneling Protocol. -- SSTP. Secure Socket Tunneling Protocol. -- IKEv2. Internet Key Exchange version 2. -- Automatic.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TunnelType</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</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></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>TunnelType</maml:name><maml:description><maml:para>Specifies a tunnel type. If you specify a value for this parameter, the cmdlet gets properties only for tunnels of that type. The acceptable values for this parameter are: -- PPTP. Point-to-Point Tunneling Protocol. -- L2TP. Layer Two Tunneling Protocol. -- SSTP. Secure Socket Tunneling Protocol. -- IKEv2. Internet Key Exchange version 2. -- Automatic.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TunnelType</command:parameterValue><dev:type><maml:name>TunnelType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Management.Infrastructure.CimInstance#VpnServerIPsecConfiguration</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Display properties</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-VpnServerIPsecConfiguration EncryptionType : OptionalEncryption Ikev2Ports : 5 SstpPorts : 10 IdleDisconnect(s) : 300 L2tpPorts : 5 SADataSizeForRenegotiation(KB) : 102400 SALifeTime(s) : 28800 </dev:code><dev:remarks><maml:para>This command displays properties for the current VPN server. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?LinkID=306251</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Set-VpnServerConfiguration</maml:linkText><maml:uri /></maml:navigationLink></maml: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-VpnServerConfiguration</command:name><maml:description><maml:para>Configures VPN server properties.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>VpnServerConfiguration</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-VpnServerConfiguration cmdlet configures virtual private network (VPN) server properties. The cmdlet modifies settings for a Routing and Remote Access service (RRAS) server for incoming server-to-server protocol (S2S protocol) VPN interfaces.</maml:para><maml:para>You can configure the size and duration of a security association (SA), and specify an idle disconnect time. </maml:para><maml:para>Specify an encryption type by using the EncryptionType parameter </maml:para><maml:para>Create a custom policy by specifying the CustomPolicy parameter. You can specify a tunnel type and how many ports to create for different tunnel types. You can also specify cipher transform constants, Diffie-Hellman (DH) group, encryption method, integrity method, and perfect forward secrecy (PFS) group. </maml:para><maml:para>Change the settings back to default values by using the RevertToDefault parameter.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-VpnServerConfiguration</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>EncryptionType</maml:name><maml:description><maml:para>Specifies the type of encryption. The acceptable values for this parameter are: -- NoEncryption -- RequireEncryption -- OptionalEncryption -- MaximumEncryption</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="IdleDurationSeconds"><maml:name>IdleDisconnectSeconds</maml:name><maml:description><maml:para>Specifies amount of time, in seconds, after which the server disconnects an idle connection. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>Ikev2Ports</maml:name><maml:description><maml:para>Specifies the number of ports to create for IKE version 2.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>L2tpPorts</maml:name><maml:description><maml:para>Specifies the number of ports to create for Layer Two Tunneling Protocol (L2TP). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="LifeTimeKiloBytes"><maml:name>SADataSizeForRenegotiationKilobytes</maml:name><maml:description><maml:para>Specifies the amount of data, in kilobytes, to transfer using a particular SA. When data transfer reaches this limit, the server renegotiates the SA.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="LifeTimeSeconds"><maml:name>SALifeTimeSeconds</maml:name><maml:description><maml:para>Specifies the length of time, in seconds, of an SA. After this interval, the SA becomes invalid.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SstpPorts</maml:name><maml:description><maml:para>Specifies the number of ports to create for Secure Socket Tunneling Protocol (SSTP). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>TunnelType</maml:name><maml:description><maml:para>Specifies a tunnel type. The custom policy applies to this type of tunnel. The acceptable values for this parameter are: -- PPTP. Point-to-Point Tunneling Protocol. -- L2TP. Layer Two Tunneling Protocol. -- SSTP. Secure Socket Tunneling Protocol. -- IKEv2. Internet Key Exchange version 2. -- Automatic.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TunnelType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><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:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-VpnServerConfiguration</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>TunnelType</maml:name><maml:description><maml:para>Specifies a tunnel type. The custom policy applies to this type of tunnel. The acceptable values for this parameter are: -- PPTP. Point-to-Point Tunneling Protocol. -- L2TP. Layer Two Tunneling Protocol. -- SSTP. Secure Socket Tunneling Protocol. -- IKEv2. Internet Key Exchange version 2. -- Automatic.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TunnelType</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RevertToDefault</maml:name><maml:description><maml:para>Indicates that the cmdlet sets IPsec properties to their default values. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><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:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-VpnServerConfiguration</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="FirstTransformType"><maml:name>AuthenticationTransformConstants</maml:name><maml:description><maml:para>Specifies authentication transform constants. The acceptable values for this parameter are: -- SHA256128 -- MD596 -- SHA196 -- GCMAES128 -- GCMAES192 -- GCMAES256 -- None</maml:para></maml:description><command:parameterValue required="true" variableLength="false">AuthenticationTransformConstants</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="FirstCipherAlgorithm,OtherCipherAlgorithm"><maml:name>CipherTransformConstants</maml:name><maml:description><maml:para>Specifies cipher transform constants. The acceptable values for this parameter are: -- DES -- DES3 -- AES128 -- AES192 -- AES256 -- GCMAES128 -- GCMAES192 -- GCMAES256 -- None</maml:para></maml:description><command:parameterValue required="true" variableLength="false">CipherTransformConstants</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>DHGroup</maml:name><maml:description><maml:para>Specifies a DH group. The server uses this value to generate IKE keys. The acceptable values for this parameter are: -- Group1 -- Group2 -- Group14 -- ECP256 -- ECP384 -- Group24 -- None</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DHGroup</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Encryption"><maml:name>EncryptionMethod</maml:name><maml:description><maml:para>Specifies an encryption method. The server uses this encryption method to generate IKE keys. The acceptable values for this parameter are: -- DES -- DES3 -- AES128 -- AES192 -- AES256</maml:para></maml:description><command:parameterValue required="true" variableLength="false">EncryptionMethod</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="IdleDurationSeconds"><maml:name>IdleDisconnectSeconds</maml:name><maml:description><maml:para>Specifies amount of time, in seconds, after which the server disconnects an idle connection. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>Ikev2Ports</maml:name><maml:description><maml:para>Specifies the number of ports to create for IKE version 2.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="FirstIntegrityAlgorithm,OtherHashAlgorithm"><maml:name>IntegrityCheckMethod</maml:name><maml:description><maml:para>Specify the integrity check method for IPsec. The acceptable values for this parameter are: -- MD5 -- SHA1 -- SHA256 -- SHA384</maml:para></maml:description><command:parameterValue required="true" variableLength="false">IntegrityCheckMethod</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>L2tpPorts</maml:name><maml:description><maml:para>Specifies the number of ports to create for Layer Two Tunneling Protocol (L2TP). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PfsGroupId"><maml:name>PfsGroup</maml:name><maml:description><maml:para>Specifies the PFS group. The acceptable values for this parameter are: -- PFS1 -- PFS2 -- PFS2048 -- ECP256 -- ECP384 -- PFSMM -- PFS24 -- None</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PfsGroup</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="LifeTimeKiloBytes"><maml:name>SADataSizeForRenegotiationKilobytes</maml:name><maml:description><maml:para>Specifies the amount of data, in kilobytes, to transfer using a particular SA. When data transfer reaches this limit, the server renegotiates the SA.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="LifeTimeSeconds"><maml:name>SALifeTimeSeconds</maml:name><maml:description><maml:para>Specifies the length of time, in seconds, of an SA. After this interval, the SA becomes invalid.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SstpPorts</maml:name><maml:description><maml:para>Specifies the number of ports to create for Secure Socket Tunneling Protocol (SSTP). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>TunnelType</maml:name><maml:description><maml:para>Specifies a tunnel type. The custom policy applies to this type of tunnel. The acceptable values for this parameter are: -- PPTP. Point-to-Point Tunneling Protocol. -- L2TP. Layer Two Tunneling Protocol. -- SSTP. Secure Socket Tunneling Protocol. -- IKEv2. Internet Key Exchange version 2. -- Automatic.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TunnelType</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CustomPolicy</maml:name><maml:description><maml:para>Indicates that the cmdlet sets custom Internet Key Exchange (IKE) Internet Protocol security (IPsec) policies.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><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:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</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></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="FirstTransformType"><maml:name>AuthenticationTransformConstants</maml:name><maml:description><maml:para>Specifies authentication transform constants. The acceptable values for this parameter are: -- SHA256128 -- MD596 -- SHA196 -- GCMAES128 -- GCMAES192 -- GCMAES256 -- None</maml:para></maml:description><command:parameterValue required="true" variableLength="false">AuthenticationTransformConstants</command:parameterValue><dev:type><maml:name>AuthenticationTransformConstants</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="FirstCipherAlgorithm,OtherCipherAlgorithm"><maml:name>CipherTransformConstants</maml:name><maml:description><maml:para>Specifies cipher transform constants. The acceptable values for this parameter are: -- DES -- DES3 -- AES128 -- AES192 -- AES256 -- GCMAES128 -- GCMAES192 -- GCMAES256 -- None</maml:para></maml:description><command:parameterValue required="true" variableLength="false">CipherTransformConstants</command:parameterValue><dev:type><maml:name>CipherTransformConstants</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CustomPolicy</maml:name><maml:description><maml:para>Indicates that the cmdlet sets custom Internet Key Exchange (IKE) Internet Protocol security (IPsec) policies.</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></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>DHGroup</maml:name><maml:description><maml:para>Specifies a DH group. The server uses this value to generate IKE keys. The acceptable values for this parameter are: -- Group1 -- Group2 -- Group14 -- ECP256 -- ECP384 -- Group24 -- None</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DHGroup</command:parameterValue><dev:type><maml:name>DHGroup</maml:name><maml:uri /></dev:type><dev:defaultValue>2</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Encryption"><maml:name>EncryptionMethod</maml:name><maml:description><maml:para>Specifies an encryption method. The server uses this encryption method to generate IKE keys. The acceptable values for this parameter are: -- DES -- DES3 -- AES128 -- AES192 -- AES256</maml:para></maml:description><command:parameterValue required="true" variableLength="false">EncryptionMethod</command:parameterValue><dev:type><maml:name>EncryptionMethod</maml:name><maml:uri /></dev:type><dev:defaultValue>4</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>EncryptionType</maml:name><maml:description><maml:para>Specifies the type of encryption. The acceptable values for this parameter are: -- NoEncryption -- RequireEncryption -- OptionalEncryption -- MaximumEncryption</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>OptionalEncryption</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="IdleDurationSeconds"><maml:name>IdleDisconnectSeconds</maml:name><maml:description><maml:para>Specifies amount of time, in seconds, after which the server disconnects an idle connection. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>Ikev2Ports</maml:name><maml:description><maml:para>Specifies the number of ports to create for IKE version 2.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="FirstIntegrityAlgorithm,OtherHashAlgorithm"><maml:name>IntegrityCheckMethod</maml:name><maml:description><maml:para>Specify the integrity check method for IPsec. The acceptable values for this parameter are: -- MD5 -- SHA1 -- SHA256 -- SHA384</maml:para></maml:description><command:parameterValue required="true" variableLength="false">IntegrityCheckMethod</command:parameterValue><dev:type><maml:name>IntegrityCheckMethod</maml:name><maml:uri /></dev:type><dev:defaultValue>2</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>L2tpPorts</maml:name><maml:description><maml:para>Specifies the number of ports to create for Layer Two Tunneling Protocol (L2TP). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</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></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PfsGroupId"><maml:name>PfsGroup</maml:name><maml:description><maml:para>Specifies the PFS group. The acceptable values for this parameter are: -- PFS1 -- PFS2 -- PFS2048 -- ECP256 -- ECP384 -- PFSMM -- PFS24 -- None</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PfsGroup</command:parameterValue><dev:type><maml:name>PfsGroup</maml:name><maml:uri /></dev:type><dev:defaultValue>3</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RevertToDefault</maml:name><maml:description><maml:para>Indicates that the cmdlet sets IPsec properties to their default values. </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></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="LifeTimeKiloBytes"><maml:name>SADataSizeForRenegotiationKilobytes</maml:name><maml:description><maml:para>Specifies the amount of data, in kilobytes, to transfer using a particular SA. When data transfer reaches this limit, the server renegotiates the SA.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="LifeTimeSeconds"><maml:name>SALifeTimeSeconds</maml:name><maml:description><maml:para>Specifies the length of time, in seconds, of an SA. After this interval, the SA becomes invalid.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SstpPorts</maml:name><maml:description><maml:para>Specifies the number of ports to create for Secure Socket Tunneling Protocol (SSTP). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>TunnelType</maml:name><maml:description><maml:para>Specifies a tunnel type. The custom policy applies to this type of tunnel. The acceptable values for this parameter are: -- PPTP. Point-to-Point Tunneling Protocol. -- L2TP. Layer Two Tunneling Protocol. -- SSTP. Secure Socket Tunneling Protocol. -- IKEv2. Internet Key Exchange version 2. -- Automatic.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TunnelType</command:parameterValue><dev:type><maml:name>TunnelType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><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"><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></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Management.Infrastructure.CimInstance#VpnServerIPsecConfiguration</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Change the idle disconnect time</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Set-VpnServerConfiguration -IdleDisconnectSeconds 1000 -PassThru WARNING: Configuration parameters will be modified after the Remote Access service is restarted. EncryptionType : OptionalEncryption Ikev2Ports : 5 IdleDisconnect(s) : 1000 L2tpPorts : 5 SADataSizeForRenegotiation(KB) : 102400 SALifeTime(s) : 28800 </dev:code><dev:remarks><maml:para>This command changes the idle disconnect time to 1000 seconds for the VPN server. The command includes the PassThru parameter, so the command sends a VpnServerIPsecConfiguration object to the console.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Configure a custom IPsec policy</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Set-VpnServerConfiguration -CustomPolicy -AuthenticationTransformConstants "SHA256128" -CipherTransformConstants "AES128" -DHhGroup "Group2" -EncryptionMethod "AES128" -IntegrityCheckMethod "SHA256" -PassThru -PfsGroup "PFS2" WARNING: Configuration parameters will be modified after the Remote Access service is restarted. AuthenticationTransformConstants : SHA256128 CipherTransformConstants : AES128 CustomPolicy : True DHGroup : Group2 EncryptionMethod : AES128 Ikev2Ports : 5 IdleDisconnect(s) : 1000 IntegrityCheckMethod : SHA256 L2tpPorts : 5 PFSgroup : PFS2 SADataSizeForRenegotiation(KB) : 102400 SALifeTime(s) : 28800 </dev:code><dev:remarks><maml:para>This command configures a custom IPsec policy for incoming VPN connections and S2S protocol VPN connections that do not use a pre-shared key as an authentication method. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?LinkID=306257</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-VpnServerConfiguration</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |