Share via


Remove method of the PS_RemoteAccessRadius class

This cmdlet removes an external RADIUS server from being used for one of the following purposes1. VPN authentication2. Accounting for both DirectAccess and VPN3. OTP authentication for DirectAccess

Syntax

uint32 Remove(
  [in]  string                          ServerName,
  [in]  string                          Purpose,
  [in]  string                          ComputerName,
  [in]  boolean                         PassThru,
  [in]  string                          EntrypointName,
  [out] RemoteAccessRadiusServerPurpose cmdletOutput[]
);

Parameters

ServerName [in]

IPv4/IPv6 address or hostname of the external RADIUS server that needs to be removed.

Purpose [in]

A Mandatory parameter that indicates the purpose for which the external RADIUS server is being removed. Can be one of the following: 1. Authentication 2. Accounting 3. Otp

Authentication ("Authentication")

Accounting ("Accounting")

Otp ("Otp")

ComputerName [in]

IPv4/IPv6 address or hostname of the machine on which the remote access server machine specific tasks should be executed. If ComputerName is specified when removing a Radius server for authentication then it is removed for the VPN server represented by ComputerName.

PassThru [in]

When this parameter is specified the cmdlet returns the Remote Access Radius Server object that represents the radius server that was removed. The cmdlet does not return an object if this parameter is not specified.

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. When the parameter is specified it indicates that the Radius server for VPN authentication should be removed 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 removed from it

cmdletOutput [out]

The output will be the address and the purpose of the RADIUS server that was removed and the purpose for which it was removed.

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