Add-RemoteAccessRadius

Add-RemoteAccessRadius

Adds a new external RADIUS server for VPN authentication, accounting for DirectAccess (DA) and VPN, or one-time password (OTP) authentication for DA.

構文

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

詳細説明

The Add-RemoteAccessRadius cmdlet adds a new external RADIUS server for one of the following purposes:
-- Accounting Radius configuration applies to both DirectAccess (DA) and VPN.
-- One-time password (OTP) RADIUS configuration applies only to DA.
-- Authentication Radius configuration applies only to VPN.

Radius server configuration for Accounting and OTP are global in nature, such as 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.

Following describes aspects of this cmdlet behavior.
-- If a RADIUS server is currently being used for a specific purpose, then it can be added for additional purpose using this cmdlet.
-- 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 authentication RADIUS. These properties are not relevant for DA OTP authentication.
-- If a user tries to add 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 issued. When adding a RADIUS server for OTP authentication both the above described parameters are ignored if specified.
-- If the accounting configuration is Windows Server® 2012 accounting, then a user can switch to external RADIUS accounting by adding an external RADIUS server for the purpose of accounting.
-- Following are some pre-requisites for adding a RADIUS server.
---- A RADIUS server cannot be added for authentication when VPN is not even installed.
---- A RADIUS server cannot be added for authentication when the authentication type is Windows or when local NPS is installed.
---- A RADIUS server cannot be added for the purpose of accounting when external RADIUS accounting is not enabled.
---- A RADIUS server cannot be added for purpose of OTP authentication if OTP authentication is not enabled.

パラメーター

-AccountingOnOffMsg<String>

Indicates the enabled state for sending of accounting on or off messages. このパラメーターに対して使用できる値:
-- Enabled.
-- Disabled. This is the default value.
This parameter is applicable only when the RADIUS server is being added for Remote Access accounting.

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-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 executed. If this parameter is specified when adding a RADIUS server for authentication, then it is added for the VPN server represented by this parameter value.

-EntrypointName<String>

Specifies the identity of a site in a multi-site deployment. This parameter is applicable only to RADIUS server configuration for VPN authentication. It is not applicable to RADIUS accounting and OTP and hence is ignored when a user tries to add a radius server for these purposes.
When this parameter is specified it indicates that the RADIUS server for VPN authentication should be added for that site.
If this parameter is not specified in a multi-site deployment, then this parameter value for the server on which the cmdlet is run is used. The server could also be represented by using the ComputerName parameter.
If this parameter and ComputerName parameter are specified and the ComputerName parameter value does not belong to the site represented by this parameter value, 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. このパラメーターに対して使用できる値:
-- Enabled.
-- Disabled. This is the default value.
This parameter is applicable only when the RADIUS server is being added for VPN authentication.

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

-Port<UInt16>

Specifies the port number on which the RADIUS server is accepting authentication requests. The default value is 1813.

-Purpose<String>

Specifies the purpose for which the external RADIUS server is being added. このパラメーターに対して使用できる値:
-- Authentication.
-- Accounting.
-- Otp.

-Score<Byte>

Specifies the initial score. The default value is 30.

-ServerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the external RADIUS server.

-SharedSecret<String>

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

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

-Timeout<UInt32>

Specifies the timeout value in seconds. The default value is 5 (seconds).

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

• None

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• Microsoft.Management.Infrastructure.CimInstance#RemoteAccessRadiusServer[]

  Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。
  The RemoteAccessRadiusServer object array consists of the following properties:
  -- IPv4 or IPv6 address, or host name, of the RADIUS server that was added.
  -- The Purpose for which the server was added property: the RADIUS server can be added for VPN authentication, accounting or OTP.
  -- Radius initial score.
  -- Radius timeout in seconds.
  -- Radius port number.
  -- For added security, the Radius shared secret property is never populated; it will always show as blank.
  -- The Status of accounting on and off messages property is always blank if the RADIUS server was added for authentication or OTP.
  -- The Status of message authenticator property is always blank if the RADIUS server was added for accounting or OTP.

例

EXAMPLE 1

This example adds the RADIUS server named 10.1.2.1 for the purpose of VPN authentication.

PS C:\> Add-RemoteAccessRadius –ServerName 10.1.2.1 Authentication "s3cr3t2" -PassThru

EXAMPLE 2

This example adds the RADIUS server named 10.1.3.1 for the purpose of accounting for DA and VPN.

PS C:\> Add-RemoteAccessRadius –ServerName 10.1.3.1 Accounting "s3cr3t5" -PassThru

関連トピック

Get-RemoteAccessRadius

Remove-RemoteAccessRadius

Set-RemoteAccessRadius