Tests credentials
Syntax
Test-DtScriptCredentials [-ServiceHost] <Server> [-Credential <PSCredential>] [<CommonParameters>]
Test-DtScriptCredentials [-ServiceHost] <Server> [-UserName] <String> [-Password] <String>
Detailed Description
This cmdlet tests the specified credentials on the specified server to confirm if they have administrative rights
Parameters
| Name | Type | Description | Required | Pipeline Input |
|---|---|---|---|---|
| Service Host |
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 |
| 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-DtScriptCredentials -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 credentials will be tested to confirm if they have administrative rights on the server. The connections for the server object are then closed.