Share via


Set method of the PS_RemoteAccessRadius class

This cmdlet edits the properties associated with an external RADIUS server being used for the following1. VPN authentication2. Accounting for DirectAccess and VPN 3. OTP authentication for DirectAccess.

Syntax

uint32 Set(
  [in]  string                   ComputerName,
  [in]  string                   Purpose,
  [in]  uint16                   Port,
  [in]  uint8                    Score,
  [in]  string                   ServerName,
  [in]  uint32                   Timeout,
  [in]  string                   SharedSecret,
  [in]  string                   AccountingOnOffMsg,
  [in]  string                   MsgAuthenticator,
  [in]  string                   EntrypointName,
  [in]  boolean                  PassThru,
  [out] RemoteAccessRadiusServer cmdletOutput[]
);

Parameters

ComputerName [in]

IPv4/IPv6 address or hostname of the machine on which the remote access server machine specific tasks should be executed.

Purpose [in]

A mandatory parameter that indicates the purpose of the RADIUS server for which the settings are being modified. Can be one of the following. 1. Authentication. 2. Accounting. 3. Otp.

Authentication ("Authentication")

Accounting ("Accounting")

Otp ("Otp")

Port [in]

Indicates the port number on which the RADIUS server is accepting authentication requests

Score [in]

Indicates the initial score.

ServerName [in]

IPv4/IPv6 address or hostname of the external RADIUS server whose properties are being modified for the specified purpose.

Timeout [in]

The value is specified in seconds

SharedSecret [in]

Shared secret between the VPN server and the specified external RADIUS server. Note that the secret is specified in clear text

AccountingOnOffMsg [in]

Indicates whether the sending of accounting on/off messages should be enabled or disabled. Can take one of the following values. 1. Enabled. 2. Disabled. This parameter is applicable only when the Radius server is being added for Remote Access accounting

Enabled ("Enabled")

Disabled ("Disabled")

MsgAuthenticator [in]

Indicates whether usage of message authenticator should be enabled or disabled. Can take one of the following values. 1. Enabled. 2. Disabled. This parameter is applicable only when the Radius server is being added for VPN authentication

Enabled ("Enabled")

Disabled ("Disabled")

EntrypointName [in]

Entrypoint refers to the identity of a site in a multi-site deployment. It is applicable only to Radius server configuration for VPN authentication. It is not applicable to Radius accounting and OTP. If this parameter is specified when editing it indicates that the properties of the Radius server for VPN authentication should be modified for that site. 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 radius server is added to it.

PassThru [in]

Returns the remote access radius server object. By default this cmdlet does not generate any output

cmdletOutput [out]

Status of message authenticator: if the Radius server was modified for accounting or OTP then this property is always blank.

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_RemoteAccessRadius