Partager via

Set-RemoteAccessRadius

  • Article

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.

Syntax

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

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

Parameters

-AccountingOnOffMsg<String>

Specifies the enabled state for sending of accounting on and off messages. The acceptable values for this parameter are:
-- Enabled.
-- Disabled.
This parameter is applicable only when the RADIUS server is being added for RA accounting.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-AsJob

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-MsgAuthenticator<String>

Specifies the enabled state for the usage of message authenticator. The acceptable values for this parameter are:
-- Enabled.
-- Disabled.
This parameter is applicable only when the RADIUS server is being added for VPN authentication.

Aliases

none

Required?

false

Position?

named

Default Value

Disable

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Port<UInt16>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Purpose<String>

Specifies the purpose of the RADIUS server for which the settings are being modified. The acceptable values for this parameter are:
-- Authentication.
-- Accounting.
-- Otp.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Score<Byte>

Specifies the initial score.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

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

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SharedSecret<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Timeout<UInt32>

Specifies the time-out value, in seconds.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

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

Examples

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

Add-RemoteAccessRadius

Get-RemoteAccessRadius

Remove-RemoteAccessRadius

Set-RemoteAccessRadius