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
 

Set-DAOtpAuthentication

Set-DAOtpAuthentication

ps_daotpauthentication_v1.0.0.cdxml

Synopsis

Configures one-time password (OTP) authentication settings for DirectAccess (DA).

Syntax

Set-DAOtpAuthentication [-AsJob] [-CAServer] [-CertificateTemplateName] [-CimSession] [-ComputerName] [-DisableTwoFactorBypass] [-PassThru] [-SigningCertificateTemplateName] [-ThrottleLimit] [-UserSecurityGroupName] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-DAOtpAuthentication cmdlet modifies the DirectAccess (DA) one-time password (OTP) settings, including certification authority (CA) servers, the certificate template used to issue one-time password (OTP) certificates, and users exempt from two-factor authentication.

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 CA servers that issue certificates for OTP authentication.

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.

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

-DisableTwoFactorBypass <SwitchParameter>

Disables the option to allow users in a specific security group to be exempt from two-factor authentication, when two-factor authentication is enabled.

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

-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 a 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 changes OTP setting for both DC1.corp.contoso.com\corp-DC1-CA and DC2.corp.contoso.com\corp-DC2-CA CA server to be used for OTP authentication. Other OTP settings will not be changed in any way. This cmdlet can be used to change single or multiple OTP settings. Note: This cmdlet will fail if OTP authentication is Disabled.

PS C:\>Set-DAOtpAuthentication -CAServer @(DC1.corp.contoso.com\corp-DC1-CA, DC2.corp.contoso.com\corp-DC2-CA) –PassThru
OtpStatus               : Enabled 
CAServers               : {dc1.corp.contoso.com\corp-DC1-CA, dc2.corp.contoso.com\corp-DC2-CA} 
CertificateTemplateName : DAOTPLogon 
RadiusServer            : {rsa.corp.contoso.com} 
UserSecurityGroupName   : 

EXAMPLE 2

This example enables two-factor authentication exemption feature and sets CORP\DirectAccessUsernamePasswordUsers as security group of users who are allowed to use username and password as user authentication for DA. The appropriate user group should be created in advance before DA admin can configure OTP for DA. A DA administrator cannot add users to this group via the DA administrator console.

PS C:\>Set-DAOtpAuthentication -UserSecuriotyGroupName corp\DirectAccessUsernamePasswordUsers –PassThru
OtpStatus               : Disabled 
CAServers               : {dc1.corp.contoso.com\corp-DC1-CA} 
CertificateTemplateName : DAOTPLogon 
RadiusServer            : {rsa.corp.contoso.com} 
UserSecurityGroupName   : CORP\DirectAccessUsernamePasswordUsers 

EXAMPLE 3

This example disables two-factor user authentication exemption feature and all DA users must use two-factor authentication such as Smart Card or OTP, as user authentication for DA. The value of the UserSecurityGroupName parameter is cleared and next time two-factor authentication feature is Enabled again, the DA administrator will have to supply the name of user security group.

PS C:\>Set-DAOtpAuthentication –DisableTwoFactorBypass –PassThru
OtpStatus               : Disabled 
CAServers               : {dc1.corp.contoso.com\corp-DC1-CA} 
CertificateTemplateName : DAOTPLogon 
RadiusServer            : {rsa.corp.contoso.com} 
UserSecurityGroupName   : 

Online Version
Disable-DAOtpAuthentication
Enable-DAOtpAuthentication
Get-DAOtpAuthentication