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.

構文

Parameter Set: Remove2
Remove-RemoteAccessRadius [-ServerName] <String> [-Purpose] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-EntrypointName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

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.

パラメーター

-AsJob

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-CimSession<CimSession[]>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

true (ByPropertyName)

ワイルドカード文字を許可する

false

-PassThru

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Purpose<String>

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

エイリアス

なし

必須?

true

位置は?

3

既定値

なし

パイプライン入力を許可する

true (ByPropertyName)

ワイルドカード文字を許可する

false

-ServerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the external RADIUS server that needs to be removed.

エイリアス

なし

必須?

true

位置は?

2

既定値

なし

パイプライン入力を許可する

true (ByPropertyName)

ワイルドカード文字を許可する

false

-ThrottleLimit<Int32>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Confirm

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

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

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

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

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

入力

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

  • None

出力

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

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

    Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。
    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.

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

関連トピック

Set-RemoteAccessAccounting

Set-VpnAuthType