This cmdlet tests the specified credentials on the specified server to confirm if they have administrative rights. For this cmdlet, the -ServiceHost could be your source or target server.

Syntax

Test-DtScriptCredentials [-Credential] <PSCredential> [-ServiceHost] <Server> [<CommonParameters>]

Test-DtScriptCredentials [-UserName] <String> [-Password] <String> [-ServiceHost] <Server> [<CommonParameters>]

Parameters

-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.

Required?	true
Position?	2
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-UserName<String>

Specify a user name. If you are using a domain, specify domain\user name.

Required?	true
Position?	2
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Password<String>

Specify the password associated with the user you have entered. This password will be visible in plain text.

Required?	true
Position?	3
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ServiceHost<Server>

Specify the server object returned from the New-DtServer cmdlet.

Required?	true
Position?	1
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Examples

------------------EXAMPLE------------------

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.

$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