HelpCache/PS_VPNAuthType_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>Set-VpnAuthType</command:name><maml:description><maml:para>Sets the authentication type to be used for connecting to a VPN.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>VpnAuthType</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-VpnAuthType cmdlet is only used to toggle from one authentication type to another. This cmdlet cannot be used to explicitly add any additional RADIUS servers if RADIUS authentication is being used. -- The parameters for RADIUS authentication properties, such as the MsgAuthenticator, RadiusPort, RadiusScore, RadiusServer, RadiusTimeout and SharedSecret parameters, are applicable only when the ExternalRadius authentication is configured. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-VpnAuthType</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Type</maml:name><maml:description><maml:para>Specifies the authentication type. The acceptable values for this parameter are: -- Windows. -- ExternalRadius. </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="3" aliases=""><maml:name>RadiusServer</maml:name><maml:description><maml:para>Specifies the IPv4 or IPv6 address, or host name, of the external RADIUS server that is used for accounting. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. Specifying the corresponding shared secret is mandatory. The default values can be used for the other parameters. </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="4" aliases=""><maml:name>SharedSecret</maml:name><maml:description><maml:para>Specifies the shared secret between the Remote Access server and the specified external RADIUS server which is required for successful communication between the two servers. Note: The secret is specified in clear text. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. When specifying a RADIUS server for authentication, it is mandatory to also specify the shared secret. The default values can be used for the other parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><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=""><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>ComputerName</maml:name><maml:description><maml:para>Specifies the IPv4 or IPv6 address, or host name, of the computer on which the VPN server computer specific tasks should be run. If this parameter is specified, then the authentication type is configured for that VPN server.</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=""><maml:name>EntrypointName</maml:name><maml:description><maml:para>Identifies a site in a multi-site deployment for which the authentication type needs to be configured. If this parameter is not specified in a multi-site deployment, then this parameter value on which the cmdlet is run is used. The server could also be represented by using the ComputerName parameter. If this parameter and the ComputerName parameter are specified and the ComputerName does not belong to the site represented by this parameter, then this parameter takes precedence and the authentication type is configured for it. </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=""><maml:name>MsgAuthenticator</maml:name><maml:description><maml:para>Specifies the enabled state for the usage of message authenticator. The acceptable values for this parameter are: -- Enabled. -- Disabled. This is the default value. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</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=""><maml:name>RadiusPort</maml:name><maml:description><maml:para>Specifies the port number on which the RADIUS server is accepting authentication requests. The default value is 1813. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>RadiusScore</maml:name><maml:description><maml:para>Specifies the initial score. The default value is 30. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Byte</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>RadiusTimeout</maml:name><maml:description><maml:para>Specifies the RADIUS time out value, in seconds. The default value is 5 seconds. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. </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="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="true" globbing="false" pipelineInput="false" position="named" aliases=""><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>ComputerName</maml:name><maml:description><maml:para>Specifies the IPv4 or IPv6 address, or host name, of the computer on which the VPN server computer specific tasks should be run. If this parameter is specified, then the authentication type is configured for that VPN server.</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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>EntrypointName</maml:name><maml:description><maml:para>Identifies a site in a multi-site deployment for which the authentication type needs to be configured. If this parameter is not specified in a multi-site deployment, then this parameter value on which the cmdlet is run is used. The server could also be represented by using the ComputerName parameter. If this parameter and the ComputerName parameter are specified and the ComputerName does not belong to the site represented by this parameter, then this parameter takes precedence and the authentication type is configured for it. </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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>MsgAuthenticator</maml:name><maml:description><maml:para>Specifies the enabled state for the usage of message authenticator. The acceptable values for this parameter are: -- Enabled. -- Disabled. This is the default value. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. </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>Disable</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=""><maml:name>RadiusPort</maml:name><maml:description><maml:para>Specifies the port number on which the RADIUS server is accepting authentication requests. The default value is 1813. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue><dev:type><maml:name>UInt16</maml:name><maml:uri /></dev:type><dev:defaultValue>1813</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>RadiusScore</maml:name><maml:description><maml:para>Specifies the initial score. The default value is 30. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Byte</command:parameterValue><dev:type><maml:name>Byte</maml:name><maml:uri /></dev:type><dev:defaultValue>30</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""><maml:name>RadiusServer</maml:name><maml:description><maml:para>Specifies the IPv4 or IPv6 address, or host name, of the external RADIUS server that is used for accounting. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. Specifying the corresponding shared secret is mandatory. The default values can be used for the other parameters. </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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>RadiusTimeout</maml:name><maml:description><maml:para>Specifies the RADIUS time out value, in seconds. The default value is 5 seconds. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. </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>5</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""><maml:name>SharedSecret</maml:name><maml:description><maml:para>Specifies the shared secret between the Remote Access server and the specified external RADIUS server which is required for successful communication between the two servers. Note: The secret is specified in clear text. This parameter can be configured only if the Type parameter is specified to be ExternalRadius. When specifying a RADIUS server for authentication, it is mandatory to also specify the shared secret. The default values can be used for the other parameters. </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="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="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Type</maml:name><maml:description><maml:para>Specifies the authentication type. The acceptable values for this parameter are: -- Windows. -- ExternalRadius. </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="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>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Management.Infrastructure.CimInstance#VpnAuth</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object. The VpnAuth object consists of the following properties: -- Authentication type: Windows or ExternalRadius. -- Configured RADIUS servers: If external RADIUS authentication was set, then the configured RADIUS servers are displayed. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Set-VpnAuthType -Type "ExternalRadius" -RadiusServer "10.1.1.1" -SharedSecret "s3cr3t" -PassThru Type : ExternalRadius RadiusServerList : {10.1.1.1} </dev:code><dev:remarks><maml:para>This example sets the VPN authentication type to be ExternalRadius. A RADIUS server is specified along with the shared secret required to communicate with that RADIUS server.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Set-VpnAuthType -Type "Windows" -PassThru Type : Windows RadiusServerList : </dev:code><dev:remarks><maml:para>This example sets the VPN authentication type to be Windows, which causes authentication to happen on the Remote Access server computer.</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/p/?linkid=294413</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-VpnAuthProtocol</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-VpnAuthProtocol</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |