Test-WssConfigurationOption
Test-WssConfigurationOption
Validates server name, domain name and domain administrator credentials.
Syntax
Parameter Set: Credential
Test-WssConfigurationOption [-Credential <PSCredential> ] [ <CommonParameters>]
Parameter Set: AdminAccount
Test-WssConfigurationOption -NetbiosName <String> -NewAdminCredential <PSCredential> [-ComputerName <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Parameter Set: ComputerName
Test-WssConfigurationOption -NetbiosName <String> [-ComputerName <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Detailed Description
The Test-WssConfigurationOption cmdlet validates server name, domain name and domain administrator credentials in Windows Server Essential Experience.
Parameters
-ComputerName<String>
Specifies the name of the computer with which to work.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies a PSCredential object. To obtain a PSCredential object, use the Get-Credential cmdlet. The cmdlet uses the credential supplied by this parameter to connect to the server to test.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NetbiosName<String>
Specifies the NetBIOS name of the domain to which the computer being tested belongs.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewAdminCredential<PSCredential>
Specifies a PSCredential object. To obtain a PSCredential object, use the Get-Credential cmdlet. The cmdlet validates the user name and password in the credential you supply, and then creates a new user account by using these credentials.
Aliases |
none |
Required? |
true |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Boolean
This cmdlet generates a value of $True or $False to represent whether you can configure Windows Server Essential Experience on the target server by using the parameter values that you specify.
Examples
Example 1: Validate a server configuration
The first command obtains a credential and stores the result in the $PsCredential variable.
The second command validates the configuration for a server named Contoso-01 in the NetBIOS domain named Contoso-dom.
PS C:\> $PsCredential = Get-Credential
PS C:\> Test-WssConfigurationOption -NetbiosName "Contoso-dom" -ComputerName "Contoso-01" -Credential $PsCredential