Set-Remote Access Radius

Syntax

Set-RemoteAccessRadius
   [-ComputerName <String>]
   [-Purpose] <String>
   [-Port <UInt16>]
   [-Score <Byte>]
   [-ServerName] <String>
   [-Timeout <UInt32>]
   [-SharedSecret <String>]
   [-AccountingOnOffMsg <String>]
   [-MsgAuthenticator <String>]
   [-EntrypointName <String>]
   [-PassThru]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-RemoteAccessRadius cmdlet edits the properties associated with an external RADIUS server being used for VPN authentication, accounting for DirectAccess (DA) and VPN, and one-time password (OTP) authentication for DA.

-- Accounting RADIUS configuration applies to both DA and VPN.

-- OTP RADIUS configuration applies only to DA.

-- Authentication RADIUS configuration applies only to VPN.

A RADIUS server configuration for Accounting and OTP are global in nature, such as applying the entire Remote Access (RA) deployment. A RADIUS server configuration for VPN applies only to a specific VPN server, and all servers in a load balancing cluster, or if multi-site is deployed, to all VPN servers at a site.

Following describes aspects of the cmdlet behavior:

-- The purpose for which a RADIUS server is currently being used cannot be changed using this cmdlet. Only the other properties of the server can be modified.

-- The RADIUS server properties for authentication and accounting are the same except for the AccountingOnOffMsg parameter which is applicable only to accounting RADIUS and the MsgAuthenticator parameter which is applicable only to RADIUS authentication. These parameters are not relevant for DA OTP authentication.

-- If a user tries to edit the properties of a RADIUS server for a particular purpose but specifies a parameter that is not applicable to that purpose, then this cmdlet will still run but the parameter will be ignored and a warning message will be displayed. The other parameters specified will still be modified.

Examples

EXAMPLE 1

PS C:\>Set-RemoteAccessRadius -ServerName 10.1.2.1 -Purpose Authentication -Timeout 10 -SharedSecret "n3ws3cr3t" -PassThru
ServerName    Purpose         Score   Timeout(s)   Port   AccountingOnOffMsg MsgAuthenticator 
----------    -------         -----   ----------   ----   ------------------ ---------------- 
10.1.2.1      Authentication  30       10          1812                      Disabled

This example configures time out and shared secret properties of the RADIUS server named 10.1.2.1 that is being used for the purpose of VPN authentication.

Required Parameters

Optional Parameters

Inputs

None

Outputs

Microsoft.Management.Infrastructure.CimInstance#RemoteAccessRadiusServer[]

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 array of RemoteAccessRadiusServer objects consists of the following properties:

-- The IPv4 or IPv6 address or host name of the RADIUS server that was modified.

-- The purpose for which the server was modified: VPN authentication, accounting or OTP.

-- The RADIUS initial score.

-- The RADIUS timeout in seconds.

-- The RADIUS port number.

-- The RADIUS shared secret: for security reasons, this property is never populated and will always show as blank.

-- The status of accounting on/off messages: if the RADIUS server was modified for authentication or OTP, then this property is always blank.

-- The status of message authenticator: if the RADIUS server was modified for accounting or OTP, then this property is always blank.

Related Links

• Add-RemoteAccessRadius
• Get-RemoteAccessRadius
• Remove-RemoteAccessRadius
• Set-RemoteAccessRadius