Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Enable-DAOtpAuthentication

Enable-DAOtpAuthentication

ps_daotpauthentication_v1.0.0.cdxml

Synopsis

Enables and configures one-time password (OTP) authentication for DirectAccess (DA) users.

Syntax

Enable-DAOtpAuthentication [-AsJob] [-CAServer] [-CertificateTemplateName] [-CimSession] [-ComputerName] [-Force] [-PassThru] [-RadiusPort] [-RadiusServer] [-SharedSecret] [-SigningCertificateTemplateName] [-ThrottleLimit] [-UserSecurityGroupName] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Enable-DAOtpAuthentication cmdlet enables one-time password (OTP) authentication for DirectAccess (DA) users, and configures OTP settings.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-CertificateTemplateName <String>

Specifies the name of the certificate template used for OTP certificate enrollment.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

Session

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 server on which the cmdlet should run.

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-RadiusPort <UInt16>

Specifies the RADIUS server port listening for authentication requests.

Aliases

Port

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-RadiusServer <String>

Specifies the IPv4 or IPv6 address, or the fully qualified domain name (FQDN), of the RADIUS server used for OTP authentication.

Aliases

Server

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-SharedSecret <String>

Specifies the shared password used for communications between the Remote Access server and the RADIUS server.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

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.

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

-UserSecurityGroupName <String>

Specifies the security group containing users who are exempt from two-factor authentication.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#DAOtpAuth

Notes

None

Examples

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
OtpStatus               : Enabled 
CAServers               : {dc1.corp.contoso.com\corp-DC1-CA} 
CertificateTemplateName : DAOTPLogon 
RadiusServer            : {rsa.corp.contoso.com} 
UserSecuriotyGroupName  : 

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
OtpStatus               : Enabled 
CAServers               : {dc1.corp.contoso.com\corp-DC1-CA} 
CertificateTemplateName : DAOTPLogon 
RadiusServer            : {rsa.corp.contoso.com} 
UserSecuriotyGroupName  : 
 
Enabling OTP authentication will change DirectAccess user authentication settings. Do you want to continue? 
[Y] Yes  [N] No  [S] Suspend  [?] Help  (default is "Y"): 

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
OtpStatus               : Enabled 
CAServers               : {dc1.corp.contoso.com\corp-DC1-CA} 
CertificateTemplateName : DAOTPLogon_v2 
RadiusServer            : {rsa.corp.contoso.com} 
UserSecuriotyGroupName  : 

Online Version
Add-RemoteAccessRadius
Get-RemoteAccessRadius
Remove-RemoteAccessRadius
Set-DAServer
Set-RemoteAccessRadius