Cmdlets > Test-DtActiveDirectoryCredentials

Test-DtActiveDirectoryCredentials

Tests credentials against Active Directory

Syntax

Test-DtActiveDirectoryCredentials [-ServiceHost] <Server> [-Credential] <PSCredential> -ComputerDomain <String> -ComputerName <String> [<CommonParameters>]

Test-DtActiveDirectoryCredentials [-ServiceHost] <Server> [-UserName] <String> [-Password] <String> -ComputerDomain <String> -ComputerName <String> [<CommonParameters>]

Detailed Description

This cmdlet tests if the specified credentials have privileges to update Active Directory on the specified server's domain.

Parameters

Name	Type	Description	Required	Pipeline Input
Service Host	Server	Specify the server object returned from the New-DtServer cmdlet. For this cmdlet, the -ServiceHost could be your source or target server.	true	false
Credential	PSCredential	Specify the credential object returned from the Windows PowerShell Get-Credential cmdlet. This password will not be visible because Windows stores an encrypted password. See Hiding your password in a PowerShell script for basic details on using this cmdlet. See your Windows PowerShell documentation for detailed instructions.	false	false
Computer Domain	String	Specify a domain name.	true	false
Computer Name	String	Specify a computer name.	true	false
UserName	String	Specify a user name. If you are using a domain, specify domain\user name.	true	false
Password	String	Specify the password associated with the user you have entered. This password will be visible in plain text.	true	false

Outputs

Boolean

Examples

$DtServerObjectAlpha= New-DtServer -Name alpha -UserName domain\administrator -Password password

$DtCredentials = Get-Credential domain\administrator

Test-DtActiveDirectoryCredentials -ServiceHost $DtServerObjectAlpha -Credential $DtCredentials

Disconnect-DtServer -ServiceHost $DtServerObjectAlpha

A server object is created for the server alpha using the domain\administrator and password credentials. It assigns the server object to the variable called DtServerObjectAlpha. Then you will be prompted for credentials for the domain\administrator account and those credentials will be stored in the variable DtCredentials. Finally, the stored credentials will be tested to see if they can update Active Directory on the server's domain. The connections for the server object are then closed.