Remove-RemoteAccessRadius
Remove-RemoteAccessRadius
Removes an external RADIUS server from being used for VPN authentication, accounting for both DirectAccess (DA) and VPN, or one-time password (OTP) authentication for DA.
Sintaxis
Parameter Set: Remove2
Remove-RemoteAccessRadius [-ServerName] <String> [-Purpose] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-EntrypointName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Descripción detallada
The Remove-RemoteAccessRadius cmdlet removes an external RADIUS server from being used for VPN authentication, Accounting for both DirectAccess (DA) and VPN, or one-time password (OTP) authentication for DA as follows.
-- 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 that the configurations apply to the entire Remote Access deployment. 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.
The following behaviors describe aspects of this cmdlet.
-- If a RADIUS server is currently being used for multiple purposes, then it can be removed for one or more of the purposes. However, the cmdlet would have to be run separately for each purpose.
-- If the last RADIUS server being used for accounting is removed, then the accounting type automatically switches to Windows accounting.
-- The User is not allowed to delete the last RADIUS server being used for VPN authentication if Radius authentication is configured.
-- When RADIUS accounting or RADIUS authentication is disabled, using the Set-RemoteAccessAccounting and Set-VpnAuthType cmdlets, then the RADIUS servers is use do not show up in the configuration and therefore cannot be explicitly removed.
Parámetros
-AsJob
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-ComputerName<String>
Specifies the IPv4 or IPv6 address, or host name, of the computer on which the Remote Access server computer specific tasks should be run. If this parameter is specified when removing a RADIUS server for authentication, then it is removed for the VPN server represented by this parameter.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EntrypointName<String>
Specifies 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 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 ComputerName are specified and the ComputerName does not belong to the site represented by this parameter, then this parameter takes precedence and the RADIUS server is removed from it.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-PassThru
Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Purpose<String>
Specifies the purpose for which the external RADIUS server is being removed. Los valores aceptables para este parámetro son los siguientes:
-- Authentication.
-- Accounting.
-- Otp.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
3 |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-ServerName<String>
Specifies the IPv4 or IPv6 address, or host name, of the external RADIUS server that needs to be removed.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
2 |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Confirm
Solicita confirmación antes de ejecutar el cmdlet.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<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#RemoteAccessRadiusServerPurpose[]
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 array of RemoteAccessRadiusServerPurpose objects consists of the following properties:
-- The IPv4 or IPv6 address of the RADIUS server that was removed.
-- The purpose for which the server was removed.
Ejemplos
EXAMPLE 1
This example removes a RADIUS server from being used for authentication. The RADIUS server named 10.1.1.1 is being used for both authentication and accounting. This cmdlet removes the server from being used for authentication.
PS C:\> Get-RemoteAccessRadius
PS C:\> Remove-RemoteAccessRadius -ServerName 10.1.1.1 -Purpose Authentication -PassThru
PS C:\> Get-RemoteAccessRadius