Get-DAOtpAuthentication

Get-DAOtpAuthentication

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

Syntax

Parameter Set: Get2
Get-DAOtpAuthentication [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-DAOtpAuthentication cmdlet displays DirectAccess (DA) one-time password (OTP) settings, including the enabled state of the OTP, the RADIUS servers used for OTP authentication, certification authority (CA) servers, the certificate template used to issue OTP certificates, and optionally, a security group of users exempt from two-factor authentication.

Parameters

-AsJob

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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

-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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#DAOtpAuth

    The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
    The DAOtpAuth object contains the following OTP authentication configuration settings for DA:.
    -- OtpStatus specifies whether OTP authentication is enabled or disabled.
    -- RadiusServer specifies the OTP RADIUS server names and addresses.
    -- UserSecurityGroupName specifies the security group of users that are 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.

Examples

EXAMPLE 1

This example retrieves OTP authentication settings from DA Server Group Policy Object (GPO) and displays the settings to the caller. If OTP authentication is Enabled, then the status will show Enabled. If OTP authentication is Disabled, then the status shown will be Disabled.

PS C:\> Get-DAOtpAuthentication

Disable-DAOtpAuthentication

Enable-DAOtpAuthentication

Set-DAOtpAuthentication