Share via

Set method of the PS_VpnAuthType class

  • Article

This cmdlet sets the authentication type to be used for VPN.

Syntax

uint32 Set(
  [in]  string  Type,
  [in]  string  RadiusServer,
  [in]  string  SharedSecret,
  [in]  uint32  RadiusTimeout,
  [in]  uint8   RadiusScore,
  [in]  uint16  RadiusPort,
  [in]  string  ComputerName,
  [in]  string  MsgAuthenticator,
  [in]  string  EntrypointName,
  [in]  boolean PassThru,
  [out] VpnAuth cmdletOutput
);

Parameters

Type [in]

Indicates the authentication type. This can be one of the following values.

Windows ("Windows")

ExternalRadius ("ExternalRadius")

RadiusServer [in]

IPv4/IPv6 address or hostname 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. If there are no pre-existing RADIUS servers configured for authentication (see cmdlet description for more details), then it is mandatory to specify a Radius server and its corresponding shared secret. Default values can be used for the other parameters

SharedSecret [in]

Shared secret between the Remote Access server and the specified external RADIUS server. This shared secret is required for successful communication between the two servers. Note that the secret is specified in clear text. This parameter can be configured only if the Type parameter is specified to be ExternalRADIUS. If there are no pre-existing RADIUS servers configured for authentication, then it is mandatory to configure one by specifying at least one Radius server and shared secret. Default values can be used for the other parameters.

RadiusTimeout [in]

The value is specified in seconds. Default is 5 secs. This parameter can be configured only if the Type parameter is specified to be ExternalRADIUS.

RadiusScore [in]

Indicates the initial score. The default is 30. This parameter can be configured only if the Type parameter is specified to be ExternalRADIUS

RadiusPort [in]

Indicates the port number on which the RADIUS server is accepting authentication requests. Default is 1813. This parameter can be configured only if the Type parameter is specified to be ExternalRADIUS.

ComputerName [in]

IPv4/IPv6 address or hostname of the machine on which the VPN server machine specific tasks should be executed. If ComputerName is specified then the authentication type is configured for that VPN server

MsgAuthenticator [in]

Indicates whether usage of message authenticator should be enabled or disabled. Can take one of the following values. 1. Enabled. 2. Disabled. By default it is disabled. This parameter can be configured only if the Type parameter is specified to be ExternalRADIUS

Enabled ("Enabled")

Disabled ("Disabled")

EntrypointName [in]

Entrypoint refers to the identity of a site in a multi-site deployment for which the authentication type needs to be configured. If an entrypoint is not specified in a multi-site deployment then the entrypoint to which the server on which the cmdlet is executed belongs is used. The server could also be represented by using the ComputerName parameter. If both entrypoint and computername are specified and the ComputerName doesn't belong to the site represented by the entrypoint then the entrypoint takes precedence and the authentication type is configured for it

PassThru [in]

Returns the VPN Auth policy object. By default this cmdlet does not generate any output

cmdletOutput [out]

  1. Authentication type (Windows, ExternalRADIUS, LocalNPS). 2. Configured RADIUS servers (if external RADIUS authentication was set)

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012
Namespace
 Root\Microsoft\Windows\RemoteAccess
MOF
RAMgmtPSProvider.mof
DLL
RAMgmtPSProvider.dll

See also

PS_VpnAuthType