Set-VpnAuthType

Set-VpnAuthType

Sets the authentication type to be used for connecting to a VPN.

Sintaxis

Parameter Set: Set0
Set-VpnAuthType [-Type] <String> [[-RadiusServer] <String> ] [[-SharedSecret] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-EntrypointName <String> ] [-MsgAuthenticator <String> ] [-PassThru] [-RadiusPort <UInt16> ] [-RadiusScore <Byte> ] [-RadiusTimeout <UInt32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Descripción detallada

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.

Parámetros

-AsJob

-CimSession<CimSession[]>

Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.

-ComputerName<String>

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.

-EntrypointName<String>

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.

-MsgAuthenticator<String>

Specifies the enabled state for the usage of message authenticator. Los valores aceptables para este parámetro son los siguientes:
-- Enabled.
-- Disabled. This is the default value.
This parameter can be configured only if the Type parameter is specified to be ExternalRadius.

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

-RadiusPort<UInt16>

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.

-RadiusScore<Byte>

Specifies the initial score.
The default value is 30.
This parameter can be configured only if the Type parameter is specified to be ExternalRadius.

-RadiusServer<String>

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.

-RadiusTimeout<UInt32>

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.

-SharedSecret<String>

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.

-ThrottleLimit<Int32>

Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.

-Type<String>

Specifies the authentication type. Los valores aceptables para este parámetro son los siguientes:
-- Windows.
-- ExternalRadius.

-Confirm

Solicita confirmación antes de ejecutar el cmdlet.

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

• None

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

• Microsoft.Management.Infrastructure.CimInstance#VpnAuth

  El objeto Microsoft.Management.Infrastructure.CimInstance es una clase contenedora que muestra objetos de Instrumental de administración de Windows (WMI). La ruta de acceso después del signo de número (#) proporciona el espacio de nombres y el nombre de clase del objeto WMI subyacente.
  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.

Ejemplos

EXAMPLE 1

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.

PS C:\> Set-VpnAuthType -Type "ExternalRadius" -RadiusServer "10.1.1.1" -SharedSecret "s3cr3t" -PassThru

EXAMPLE 2

This example sets the VPN authentication type to be Windows, which causes authentication to happen on the Remote Access server computer.

PS C:\> Set-VpnAuthType -Type "Windows" -PassThru

Temas relacionados

Get-VpnAuthProtocol

Set-VpnAuthProtocol