Test-CauSetup
Test-CauSetup
Tests whether a cluster is properly set up to apply software updates using Cluster-Aware Updating (CAU).
Syntax
Parameter Set: Default
Test-CauSetup [[-ClusterName] <String> ] [[-Credential] <PSCredential> ] [ <CommonParameters>]
Detailed Description
The Test-CauSetup cmdlet tests whether a failover cluster is properly set up to apply software updates using Cluster-Aware Updating (CAU). The cmdlet performs a Best Practices Analyzer (BPA) scan of the failover cluster and network environment by invoking the ClusterAwareUpdating BPA model that is installed with CAU. To view the results of a BPA scan that is performed by Test-CauSetup, including possible problems and resolution steps, run the Get-BpaResult cmdlet.
Note: You must run Test-CauSetup with local administrative credentials.
Parameters
-ClusterName<String>
Specifies the name of the cluster on which to test for proper setup. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the administrative credentials for the target cluster.
Aliases |
none |
Required? |
false |
Position? |
2 |
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.ClusterAwareUpdating.CauBpaProgress
Examples
EXAMPLE 1
This example tests whether failover cluster CONTOSO-FC1 is properly set up for CAU.
PS C:\> Test-CauSetup -ClusterName CONTOSO-FC1