Enable-DAOtpAuthentication
Enable-DAOtpAuthentication
Enables and configures one-time password (OTP) authentication for DirectAccess (DA) users.
構文
Parameter Set: Enable1
Enable-DAOtpAuthentication [-AsJob] [-CAServer <String[]> ] [-CertificateTemplateName <String> ] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-PassThru] [-RadiusPort <UInt16> ] [-RadiusServer <String> ] [-SharedSecret <String> ] [-SigningCertificateTemplateName <String> ] [-ThrottleLimit <Int32> ] [-UserSecurityGroupName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Enable-DAOtpAuthentication cmdlet enables one-time password (OTP) authentication for DirectAccess (DA) users, and configures OTP settings.
パラメーター
-AsJob
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CAServer<String[]>
Specifies the certification authority (CA) servers that issue certificates for OTP authentication. Specify a server in the following format:
-- CAServer_Name\CAService_Name
.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-CertificateTemplateName<String>
Specifies the name of the certificate template used for OTP certificate enrollment.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。
エイリアス |
Session |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ComputerName<String>
Specifies the IPv4 or IPv6 address, or host name, of the server on which the cmdlet should run.
エイリアス |
Cn |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PassThru
作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RadiusPort<UInt16>
Specifies the RADIUS server port listening for authentication requests.
エイリアス |
Port |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-RadiusServer<String>
Specifies the IPv4 or IPv6 address, or the fully qualified domain name (FQDN), of the RADIUS server used for OTP authentication.
エイリアス |
Server |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-SharedSecret<String>
Specifies the shared password used for communications between the Remote Access server and the RADIUS server.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-SigningCertificateTemplateName<String>
Specifies the name of the certificate template used to enroll the certificate used by Remote Access to sign certificates used for OTP authentication.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-ThrottleLimit<Int32>
このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0
を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-UserSecurityGroupName<String>
Specifies the security group containing users who are exempt from two-factor authentication.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
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#DAOtpAuth
Microsoft.Management.Infrastructure.CimInstance
オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#
) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。
The object contains the following OTP authentication configuration settings:
-- OtpStatus specifies whether OTP authentication is enabled or disabled.
-- RadiusServer specifies OTP RADIUS server names and addresses.
-- UserSecurityGroupName specifies security group of users exempt from two-factor authentication.
-- CAServer specifies the CA servers used for OTP authentication.
-- CertificateTemplateName specifies the name of the OTP certificate template.
-- SigningCertificateTemplateName specifies the name of the certificate template used to enroll the certificate used by Remote Access to sign certificates used for OTP authentication.
例
Example 1
This example enables OTP authentication for DA users while setting the following.
-- rsa.corp.contoso.com as RADIUS or OTP server used to verify users OTP credentials.
-- dc1.corp.contoso.com\corp-DC1-CA as CA server used to enroll smart card logon short lived certificates.
-- DAOTPLogon as enroll smart card logon short lived certificates template.
All of the above settings should be set up in advance before the DA administrator can configure OTP for DA. UserSecurityGroupName is an optional setting and thus was not set which means that the two-factor authentication exemption feature is Disabled.
This cmdlet can add one new OTP Radius server each time it runs, for additional handling of Radius servers for OTP please use RemoteAccessRadius cmdlets.
Note: This cmdlet will enable OTP if two-factor user authentication and computer certificates were already enabled using the Set-DAServer cmdlet. If PKI and two-factor user authentication are disabled, then this cmdlet fails. In addition enabling OTP authentication does not disable smart card or any other two-factor authentication available to the DA user.
PS C:\> Enable-DAOtpAuthentication –RadiusServer rsa.corp.contoso.com –SharedSecret abcd123$ -CAServers dc1.corp.contoso.com\corp-DC1-CA –CertificateTemplateName DAOTPLogon –PassThru -Force
If the Force parameter is not used, then the DA administrator is presented with the following prompt.
PS C:\> Enable-DAOtpAuthentication –RadiusServer rsa.corp.contoso.com –SharedSecret abcd123$ -CAServers dc1.corp.contoso.com\corp-DC1-CA –CertificateTemplateName DAOTPLogon –PassThru
Example 2
This example enables OTP authentication for DA users while keeping the OTP settings for RadiusServer and CAServers that were set before OTP authentication was disabled. The CertificateTemplateName setting was updated to the new value.
The new smart card logon short lived certificates template should be created before running this cmdlet.
PS C:\> Enable-DAOtpAuthentication -CertificateTemplateName DAOTPLogon_v2 –PassThru -Force