Set-RemoteAccessRadius

Set-RemoteAccessRadius

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.

Sintaxis

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

Descripción detallada

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.

Parámetros

-AccountingOnOffMsg<String>

Specifies the enabled state for sending of accounting on and off messages. Los valores aceptables para este parámetro son los siguientes:
-- Enabled.
-- Disabled.
This parameter is applicable only when the RADIUS server is being added for RA accounting.

-AsJob

-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.

-ComputerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the computer on which the RA server computer specific tasks should be run.

-EntrypointName<String>

Specifies a site in a multi-site deployment. This parameter is applicable only to RADIUS server configuration for VPN authentication. This parameter is not applicable to RADIUS accounting and OTP.
If this parameter is specified when editing, then it indicates that the properties of the RADIUS server for VPN authentication should be modified for that site.
If an entry point is not specified in a multi-site deployment, then the entry point to which the server on which the cmdlet is run belongs is used. The server could also be represented by using the ComputerName parameter.
If this parameter and the ComputerName parameter are specified and the ComputerName parameter does not belong to the site represented by this parameter, then this parameter takes precedence and the RADIUS server is added to it.

-MsgAuthenticator<String>

Specifies the enabled state for the usage of message authenticator. Los valores aceptables para este parámetro son los siguientes:
-- Enabled.
-- Disabled.
This parameter is applicable only when the RADIUS server is being added for VPN authentication.

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

-Port<UInt16>

Specifies the port number on which the RADIUS server is accepting authentication requests.

-Purpose<String>

Specifies the purpose of the RADIUS server for which the settings are being modified. Los valores aceptables para este parámetro son los siguientes:
-- Authentication.
-- Accounting.
-- Otp.

-Score<Byte>

Specifies the initial score.

-ServerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the external RADIUS server for which the properties are being modified for the specified purpose.

-SharedSecret<String>

Specifies the shared secret between the VPN server and the specified external RADIUS server. Note: The secret is specified in plain text.

-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.

-Timeout<UInt32>

Specifies the time-out value, in seconds.

-Confirm

Solicita confirmación antes de ejecutar el cmdlet.

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

<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#RemoteAccessRadiusServer[]

  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 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.

Ejemplos

EXAMPLE 1

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.

PS C:\> Set-RemoteAccessRadius -ServerName 10.1.2.1 -Purpose Authentication -Timeout 10 -SharedSecret "n3ws3cr3t" -PassThru

Temas relacionados

Add-RemoteAccessRadius

Get-RemoteAccessRadius

Remove-RemoteAccessRadius

Set-RemoteAccessRadius